public class TIFFField extends Object implements Comparable
A field in a TIFF Image File Directory (IFD) is defined as a
tag number accompanied by a sequence of values of identical data type.
TIFF 6.0 defines 12 data types; a 13th type IFD
is
defined in TIFF Tech Note 1 of TIFF Specification Supplement 1. These
TIFF data types are referred to by Java constants and mapped internally
onto Java language data types and type names as follows:
TIFF Data Type | Java Constant | Java Data Type | Java Type Name |
---|---|---|---|
BYTE |
TIFFTag.TIFF_BYTE
|
byte
|
"Byte"
|
ASCII |
TIFFTag.TIFF_ASCII
|
String
|
"Ascii"
|
SHORT |
TIFFTag.TIFF_SHORT
|
char
|
"Short"
|
LONG |
TIFFTag.TIFF_LONG
|
long
|
"Long"
|
RATIONAL |
TIFFTag.TIFF_RATIONAL
|
long[2] {numerator, denominator}
|
"Rational"
|
SBYTE |
TIFFTag.TIFF_SBYTE
|
byte
|
"SByte"
|
UNDEFINED |
TIFFTag.TIFF_UNDEFINED
|
byte
|
"Undefined"
|
SSHORT |
TIFFTag.TIFF_SSHORT
|
short
|
"SShort"
|
SLONG |
TIFFTag.TIFF_SLONG
|
int
|
"SLong"
|
SRATIONAL |
TIFFTag.TIFF_SRATIONAL
|
int[2] {numerator, denominator}
|
"SRational"
|
FLOAT |
TIFFTag.TIFF_FLOAT
|
float
|
"Float"
|
DOUBLE |
TIFFTag.TIFF_DOUBLE
|
double
|
"Double"
|
IFD |
TIFFTag.TIFF_IFD_POINTER
|
long
|
"IFDPointer"
|
TIFFDirectory
,
TIFFTag
Modifier and Type | Field and Description |
---|---|
private int |
count
The number of data items present in the field.
|
private Object |
data
The field data.
|
private static boolean[] |
isIntegral |
private TIFFTag |
tag
The tag.
|
private int |
tagNumber
The tag number.
|
private int |
type
The tag type.
|
private static String[] |
typeNames |
Modifier | Constructor and Description |
---|---|
private |
TIFFField()
The default constructor.
|
|
TIFFField(TIFFTag tag,
int value)
Constructs a
TIFFField with a single integral value. |
|
TIFFField(TIFFTag tag,
int type,
int count)
Constructs a data array using
and invokes
TIFFField(TIFFTag,int,int,Object) with the supplied
parameters and the created array. |
|
TIFFField(TIFFTag tag,
int type,
int count,
Object data)
Constructs a
TIFFField with arbitrary data. |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object o)
Compares this
TIFFField with another
TIFFField by comparing the tags. |
static Object |
createArrayForType(int dataType,
int count)
Creates an array appropriate for the indicated data type.
|
static TIFFField |
createFromMetadataNode(TIFFTagSet tagSet,
Node node)
Creates a
TIFFField from a TIFF native image
metadata node. |
byte[] |
getAsBytes()
Returns the data as an uninterpreted array of
byte s. |
char[] |
getAsChars()
Returns
TIFFTag.TIFF_SHORT data as an array of
char s (unsigned 16-bit integers). |
double |
getAsDouble(int index)
Returns data in any format as a
double . |
double[] |
getAsDoubles()
Returns
TIFFTag.TIFF_DOUBLE data as an array of
double s (64-bit floating-point values). |
float |
getAsFloat(int index)
Returns data in any format as a
float . |
float[] |
getAsFloats()
Returns
TIFFTag.TIFF_FLOAT data as an array of
float s (32-bit floating-point values). |
int |
getAsInt(int index)
Returns data in any format as an
int . |
int[] |
getAsInts()
Returns
TIFFTag.TIFF_SLONG data as an array of
int s (signed 32-bit integers). |
long |
getAsLong(int index)
Returns data in any format as a
long . |
long[] |
getAsLongs()
Returns
TIFFTag.TIFF_LONG or
TIFF_IFD_POINTER data as an array of
long s (signed 64-bit integers). |
Node |
getAsNativeNode()
Returns the
TIFFField as a node named either
"TIFFField" or "TIFFIFD" as described in the
TIFF native image metadata specification. |
long[] |
getAsRational(int index)
Returns a TIFFTag.TIFF_RATIONAL data item as a two-element array
of ints.
|
long[][] |
getAsRationals()
Returns
TIFFTag.TIFF_RATIONAL data as an array of
2-element arrays of long s. |
short[] |
getAsShorts()
Returns
TIFFTag.TIFF_SSHORT data as an array of
short s (signed 16-bit integers). |
int[] |
getAsSRational(int index)
Returns a
TIFFTag.TIFF_SRATIONAL data item as a
two-element array of int s. |
int[][] |
getAsSRationals()
Returns
TIFFTag.TIFF_SRATIONAL data as an array of
2-element arrays of int s. |
String |
getAsString(int index)
Returns a
TIFFTag.TIFF_ASCII value as a
String . |
private static String |
getAttribute(Node node,
String attrName) |
int |
getCount()
Returns the number of data items present in the field.
|
Object |
getData()
Returns a reference to the data object associated with the field.
|
TIFFTag |
getTag()
Retrieves the tag associated with this field.
|
int |
getTagNumber()
Retrieves the tag number in the range
[0, 65535] . |
int |
getType()
Returns the type of the data stored in the field.
|
static int |
getTypeByName(String typeName)
Returns the data type constant corresponding to the supplied data
type name.
|
static String |
getTypeName(int dataType)
Returns the name of the supplied data type constant.
|
String |
getValueAsString(int index)
Returns a
String containing a human-readable
version of the data item. |
private static void |
initData(Node node,
int[] otype,
int[] ocount,
Object[] odata) |
boolean |
isIntegral()
Indicates whether the value associated with the field is of
integral data type.
|
private static final String[] typeNames
private static final boolean[] isIntegral
private TIFFTag tag
private int tagNumber
private int type
private int count
private Object data
private TIFFField()
public TIFFField(TIFFTag tag, int type, int count, Object data)
TIFFField
with arbitrary data. The
type
parameter must be a value for which
tag.isDataTypeOK()
returns true
. The data
parameter must
be an array of a Java type appropriate for the type of the TIFF
field unless tag.isIFDPointer()
returns true
in
which case it must be a TIFFDirectory
instance.
Neither the legality of type
with respect to
tag
nor that or data
with respect to
type
is verified by this constructor. The methods
and TIFFTag.isDataTypeOK()
should be used programmatically to ensure that subsequent errors
such as createArrayForType()
ClassCastException
s do not occur as a result
of providing inconsitent parameters to this constructor.
Note that the value (data) of the TIFFField
will always be the actual field value regardless of the number of
bytes required for that value. This is the case despite the fact
that the TIFF IFD Entry corresponding to the field may
actually contain the offset to the field's value rather than
the value itself (the latter occurring if and only if the
value fits into 4 bytes). In other words, the value of the
field will already have been read from the TIFF stream. This
subsumes the case where tag.isIFDPointer()
returns
true
and the value will be a TIFFDirectory
rather than an array.
tag
- The tag to associated with this field.type
- One of the TIFFTag.TIFF_*
constants
indicating the data type of the field as written to the TIFF stream.count
- The number of data values.data
- The actual data content of the field.IllegalArgumentException
- if tag == null
.IllegalArgumentException
- if dataType
is not
one of the TIFFTag.TIFF_*
data type constants.IllegalArgumentException
- if count < 0
.public TIFFField(TIFFTag tag, int type, int count)
createArrayForType()
and invokes
TIFFField(TIFFTag,int,int,Object)
with the supplied
parameters and the created array.TIFFField(TIFFTag,int,int,Object)
public TIFFField(TIFFTag tag, int value)
TIFFField
with a single integral value.
The field will have type
TIFF_SHORT
if
val < 65536
and type
TIFF_LONG
otherwise.
It is not verified whether the resulting type is
legal for tag
.tag
- The tag to associate with this field.value
- The value to associate with this field.IllegalArgumentException
- if tag == null
.IllegalArgumentException
- if value < 0
.public static TIFFField createFromMetadataNode(TIFFTagSet tagSet, Node node)
TIFFField
from a TIFF native image
metadata node. If the value of the "tagNumber" attribute
of the node is not found in tagSet
then a new
TIFFTag
with name "unknown"
will be
created and assigned to the field.tagSet
- The TIFFTagSet
to which the
TIFFTag
of the field belongs.node
- A native TIFF image metadata TIFFField
node.IllegalArgumentException
- if node
is
null
.IllegalArgumentException
- if the name of the node is not
"TIFFField"
.public TIFFTag getTag()
TIFFTag
.public int getTagNumber()
[0, 65535]
.public int getType()
TIFFTag.TIFF_*
constants. For future revisions of TIFF, higher values are possible.public static String getTypeName(int dataType)
dataType
- One of the TIFFTag.TIFF_*
constants
indicating the data type of the field as written to the TIFF stream.IllegalArgumentException
- if dataType
is not
one of the TIFFTag.TIFF_*
data type constants.public static int getTypeByName(String typeName)
-1
will be returned.TIFFTag.TIFF_*
constants or
-1
if the name is not recognized.public static Object createArrayForType(int dataType, int count)
dataType
- One of the TIFFTag.TIFF_*
data type
constants.count
- The number of values in the array.IllegalArgumentException
- if dataType
is not
one of the TIFFTag.TIFF_*
data type constants.IllegalArgumentException
- if count < 0
.public Node getAsNativeNode()
TIFFField
as a node named either
"TIFFField" or "TIFFIFD" as described in the
TIFF native image metadata specification. The node will be named
"TIFFIFD" if and only if the field's data object is an
instance of TIFFDirectory
or equivalently
getTag.isIFDPointer()
returns
true
.Node
named "TIFFField" or
"TIFFIFD".public boolean isIntegral()
public int getCount()
TIFFTag.TIFF_ASCII
fields, the value returned is the
number of String
s, not the total length of the
data as in the file representation.public Object getData()
public byte[] getAsBytes()
byte
s. The type of the field must be one of
TIFFTag.TIFF_BYTE
, TIFF_SBYTE
, or
TIFF_UNDEFINED
.
For data in TIFFTag.TIFF_BYTE
format, the application
must take care when promoting the data to longer integral types
to avoid sign extension.
ClassCastException
- if the field is not of type
TIFF_BYTE
, TIFF_SBYTE
, or
TIFF_UNDEFINED
.public char[] getAsChars()
TIFFTag.TIFF_SHORT
data as an array of
char
s (unsigned 16-bit integers).ClassCastException
- if the field is not of type
TIFF_SHORT
.public short[] getAsShorts()
TIFFTag.TIFF_SSHORT
data as an array of
short
s (signed 16-bit integers).ClassCastException
- if the field is not of type
TIFF_SSHORT
.public int[] getAsInts()
TIFFTag.TIFF_SLONG
data as an array of
int
s (signed 32-bit integers).ClassCastException
- if the field is not of type
TIFF_SHORT
, TIFF_SSHORT
, or
TIFF_SLONG
.public long[] getAsLongs()
TIFFTag.TIFF_LONG
or
TIFF_IFD_POINTER
data as an array of
long
s (signed 64-bit integers).ClassCastException
- if the field is not of type
TIFF_LONG
or TIFF_IFD_POINTER
.public float[] getAsFloats()
TIFFTag.TIFF_FLOAT
data as an array of
float
s (32-bit floating-point values).ClassCastException
- if the field is not of type
TIFF_FLOAT
.public double[] getAsDoubles()
TIFFTag.TIFF_DOUBLE
data as an array of
double
s (64-bit floating-point values).ClassCastException
- if the field is not of type
TIFF_DOUBLE
.public int[][] getAsSRationals()
TIFFTag.TIFF_SRATIONAL
data as an array of
2-element arrays of int
s.ClassCastException
- if the field is not of type
TIFF_SRATIONAL
.public long[][] getAsRationals()
TIFFTag.TIFF_RATIONAL
data as an array of
2-element arrays of long
s.ClassCastException
- if the field is not of type
TIFF_RATIONAL
.public int getAsInt(int index)
int
.
TIFFTag.TIFF_BYTE
values are treated as unsigned; that
is, no sign extension will take place and the returned value
will be in the range [0, 255]. TIFF_SBYTE
data
will be returned in the range [-128, 127].
A TIFF_UNDEFINED
value is treated as though
it were a TIFF_BYTE
.
Data in TIFF_SLONG
, TIFF_LONG
,
TIFF_FLOAT
, TIFF_DOUBLE
or
TIFF_IFD_POINTER
format are simply cast to
int
and may suffer from truncation.
Data in TIFF_SRATIONAL
or
TIFF_RATIONAL
format are evaluated by dividing the
numerator into the denominator using double-precision
arithmetic and then casting to int
. Loss of
precision and truncation may occur.
Data in TIFF_ASCII
format will be parsed as by
the Double.parseDouble
method, with the result
case to int
.
public long getAsLong(int index)
long
.
TIFFTag.TIFF_BYTE
and TIFF_UNDEFINED
data
are treated as unsigned; that is, no sign extension will take
place and the returned value will be in the range [0, 255].
TIFF_SBYTE
data will be returned in the range
[-128, 127].
Data in TIFF_ASCII
format will be parsed as by
the Double.parseDouble
method, with the result
cast to long
.
public float getAsFloat(int index)
float
.
TIFFTag.TIFF_BYTE
and TIFF_UNDEFINED
data
are treated as unsigned; that is, no sign extension will take
place and the returned value will be in the range [0, 255].
TIFF_SBYTE
data will be returned in the range
[-128, 127].
Data in TIFF_SLONG
, TIFF_LONG
,
TIFF_DOUBLE
, or TIFF_IFD_POINTER
format are
simply cast to float
and may suffer from
truncation.
Data in TIFF_SRATIONAL
or
TIFF_RATIONAL
format are evaluated by dividing the
numerator into the denominator using double-precision
arithmetic and then casting to float
.
Data in TIFF_ASCII
format will be parsed as by
the Double.parseDouble
method, with the result
cast to float
.
public double getAsDouble(int index)
double
.
TIFFTag.TIFF_BYTE
and TIFF_UNDEFINED
data
are treated as unsigned; that is, no sign extension will take
place and the returned value will be in the range [0, 255].
TIFF_SBYTE
data will be returned in the range
[-128, 127].
Data in TIFF_SRATIONAL
or
TIFF_RATIONAL
format are evaluated by dividing the
numerator into the denominator using double-precision
arithmetic.
Data in TIFF_ASCII
format will be parsed as by
the Double.parseDouble
method.
public String getAsString(int index)
TIFFTag.TIFF_ASCII
value as a
String
.ClassCastException
- if the field is not of type
TIFF_ASCII
.public int[] getAsSRational(int index)
TIFFTag.TIFF_SRATIONAL
data item as a
two-element array of int
s.ClassCastException
- if the field is not of type
TIFF_SRATIONAL
.public long[] getAsRational(int index)
ClassCastException
- if the field is not of type
TIFF_RATIONAL
.public String getValueAsString(int index)
String
containing a human-readable
version of the data item. Data of type
TIFFTag.TIFF_RATIONAL
or TIFF_SRATIONAL
are
represented as a pair of integers separated by a
'/'
character.ClassCastException
- if the field is not of one of the
legal field types.public int compareTo(Object o)
TIFFField
with another
TIFFField
by comparing the tags.
Note: this class has a natural ordering that is inconsistent
with equals()
.
compareTo
in interface Comparable
IllegalArgumentException
- if the parameter is null
.ClassCastException
- if the parameter is not a
TIFFField
.Copyright © 2016 Open Microscopy Environment