Class TIFFField

public TIFFField(TIFFTag tag, int type, int count, Object data)

Constructs a 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.

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 value of the field 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. (An exception to this case may occur when the field represents the contents of a non-baseline IFD. In that case the data will be a long[] containing the offset to the IFD and the TIFFDirectory returned by getDirectory() will be its contents.)

public TIFFField(TIFFTag tag, int type, int count)

Constructs a data array using createArrayForType() and invokes TIFFField(TIFFTag,int,int,Object) with the supplied parameters and the created array.

public TIFFField(TIFFTag tag, long value)

Constructs a TIFFField with a single non-negative integral value. The field will have type TIFF_SHORT if value is in [0,0xffff], and type TIFF_LONG if value is in [0x10000,0xffffffff]. The count of the field will be unity.

public TIFFField(TIFFTag tag, int type, long offset, TIFFDirectory dir)

Constructs a TIFFField with an IFD offset and contents. The offset will be stored as the data of this field as long[] {offset}. The directory will not be cloned. The count of the field will be unity.

public static TIFFField createFromMetadataNode(TIFFTagSet tagSet, Node node)

Creates a TIFFField from a TIFF native image metadata node. If the value of the "number" attribute of the node is not found in tagSet then a new TIFFTag with name TIFFTag.UNKNOWN_TAG_NAME will be created and assigned to the field.

public TIFFTag getTag()

Retrieves the tag associated with this field.

public int getTagNumber()

Retrieves the tag number in the range [0,65535].

public int getType()

Returns the type of the data stored in the field. For a TIFF 6.0 stream, the value will equal one of the TIFFTag.TIFF_* constants. For future revisions of TIFF, higher values are possible.

public static String getTypeName(int dataType)

Returns the name of the supplied data type constant.

public static int getTypeByName(String typeName)

Returns the data type constant corresponding to the supplied data type name. If the name is unknown -1 will be returned.

public static Object createArrayForType(int dataType, int count)

Creates an array appropriate for the indicated data type.

public Node getAsNativeNode()

Returns the 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 hasDirectory() returns true and the field's type is either TIFFTag.TIFF_LONG or TIFFTag.TIFF_IFD_POINTER.

public boolean isIntegral()

Indicates whether the value associated with the field is of integral data type.

public int getCount()

Returns the number of data items present in the field. For TIFFTag.TIFF_ASCII fields, the value returned is the number of Strings, not the total length of the data as in the file representation.

public Object getData()

Returns a reference to the data object associated with the field.

public byte[] getAsBytes()

Returns the data as an uninterpreted array of bytes. 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.

public char[] getAsChars()

Returns TIFFTag.TIFF_SHORT data as an array of chars (unsigned 16-bit integers).

public short[] getAsShorts()

Returns TIFFTag.TIFF_SSHORT data as an array of shorts (signed 16-bit integers).

public int[] getAsInts()

Returns TIFFTag.TIFF_SLONG data as an array of ints (signed 32-bit integers).

public long[] getAsLongs()

Returns TIFFTag.TIFF_LONG or TIFF_IFD_POINTER data as an array of longs (signed 64-bit integers).

public float[] getAsFloats()

Returns TIFFTag.TIFF_FLOAT data as an array of floats (32-bit floating-point values).

public double[] getAsDoubles()

Returns TIFFTag.TIFF_DOUBLE data as an array of doubles (64-bit floating-point values).

public int[][] getAsSRationals()

Returns TIFFTag.TIFF_SRATIONAL data as an array of 2-element arrays of ints.

public long[][] getAsRationals()

Returns TIFFTag.TIFF_RATIONAL data as an array of 2-element arrays of longs.

public int getAsInt(int index)

Returns data in any format as an 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)

Returns data in any format as a 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_FLOAT and TIFF_DOUBLE are simply cast to long 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 long. Loss of precision and truncation may occur.

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)

Returns data in any format as a 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)

Returns data in any format as a 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)

Returns a TIFFTag.TIFF_ASCII value as a String.

public int[] getAsSRational(int index)

Returns a TIFFTag.TIFF_SRATIONAL data item as a two-element array of ints.

public long[] getAsRational(int index)

Returns a TIFFTag.TIFF_RATIONAL data item as a two-element array of ints.

public String getValueAsString(int index)

Returns a 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. If the numerator of a TIFFTag.TIFF_RATIONAL or TIFF_SRATIONAL is an integral multiple of the denominator, then the value is represented as "q/1" where q is the quotient of the numerator and denominator.

public boolean hasDirectory()

Returns whether the field has a TIFFDirectory.

public TIFFDirectory getDirectory()

Returns the associated TIFFDirectory, if available. If no directory is set, then null will be returned.

public TIFFField clone() throws CloneNotSupportedException

Clones the field and all the information contained therein.