| java.lang.Object
 org.apache.xmlgraphics.image.codec.tiff.TIFFDirectory
| TIFFDirectory | | public class TIFFDirectory extends Object implements Serializable(Code) | | A class representing an Image File Directory (IFD) from a TIFF 6.0
stream. The TIFF file format is described in more detail in the
comments for the TIFFDescriptor class.
A TIFF IFD consists of a set of TIFFField tags. Methods are
provided to query the set of tags and to obtain the raw field
array. In addition, convenience methods are provided for acquiring
the values of tags that contain a single value that fits into a
byte, int, long, float, or double.
Every TIFF file is made up of one or more public IFDs that are
joined in a linked list, rooted in the file header. A file may
also contain so-called private IFDs that are referenced from
tag data and do not appear in the main list.
This class is not a committed part of the JAI API. It may
be removed or changed in future releases of JAI.
See Also: TIFFField
version:
$Id: TIFFDirectory.java 496559 2007-01-16 01:10:29Z cam $ |
| Method Summary | |
| public TIFFField | getField(int tag)
Returns the value of a given tag as a TIFFField,
or null if the tag is not present. | | public byte | getFieldAsByte(int tag, int index)
Returns the value of a particular index of a given tag as a
byte. | | public byte | getFieldAsByte(int tag)
Returns the value of index 0 of a given tag as a
byte. | | public double | getFieldAsDouble(int tag, int index)
Returns the value of a particular index of a given tag as a
double. | | public double | getFieldAsDouble(int tag)
Returns the value of index 0 of a given tag as a double. | | public float | getFieldAsFloat(int tag, int index)
Returns the value of a particular index of a given tag as a
float. | | public float | getFieldAsFloat(int tag)
Returns the value of index 0 of a given tag as a float. | | public long | getFieldAsLong(int tag, int index)
Returns the value of a particular index of a given tag as a
long. | | public long | getFieldAsLong(int tag)
Returns the value of index 0 of a given tag as a
long. | | public TIFFField[] | getFields()
Returns an array of TIFFFields containing all the fields
in this directory. | | public long | getIFDOffset()
Returns the offset of the IFD corresponding to this
TIFFDirectory. | | public long | getNextIFDOffset()
Returns the offset of the next IFD after the IFD corresponding to this
TIFFDirectory. | | public static int | getNumDirectories(SeekableStream stream)
Returns the number of image directories (subimages) stored in a
given TIFF file, represented by a SeekableStream. | | public int | getNumEntries()
Returns the number of directory entries. | | public int[] | getTags()
Returns an ordered array of ints indicating the tag
values. | | public boolean | isBigEndian()
Returns a boolean indicating whether the byte order used in the
the TIFF file is big-endian. | | public boolean | isTagPresent(int tag)
Returns true if a tag appears in the directory. |
| IFDOffset | | long IFDOffset(Code) | | The offset of this IFD.
|
| fieldIndex | | Map fieldIndex(Code) | | A Hashtable indexing the fields by tag number.
|
| isBigEndian | | boolean isBigEndian(Code) | | A boolean storing the endianness of the stream.
|
| nextIFDOffset | | long nextIFDOffset(Code) | | The offset of the next IFD.
|
| numEntries | | int numEntries(Code) | | The number of entries in the IFD.
|
| TIFFDirectory | | TIFFDirectory()(Code) | | The default constructor.
|
| TIFFDirectory | | public TIFFDirectory(SeekableStream stream, int directory) throws IOException(Code) | | Constructs a TIFFDirectory from a SeekableStream.
The directory parameter specifies which directory to read from
the linked list present in the stream; directory 0 is normally
read but it is possible to store multiple images in a single
TIFF file by maintaing multiple directories.
Parameters:
stream - a SeekableStream to read from.
Parameters:
directory - the index of the directory to read. |
| TIFFDirectory | | public TIFFDirectory(SeekableStream stream, long ifd_offset, int directory) throws IOException(Code) | | Constructs a TIFFDirectory by reading a SeekableStream.
The ifd_offset parameter specifies the stream offset from which
to begin reading; this mechanism is sometimes used to store
private IFDs within a TIFF file that are not part of the normal
sequence of IFDs.
Parameters:
stream - a SeekableStream to read from.
Parameters:
ifd_offset - the long byte offset of the directory.
Parameters:
directory - the index of the directory to read beyond theone at the current stream offset; zero indicates the IFDat the current offset. |
| getField | | public TIFFField getField(int tag)(Code) | | Returns the value of a given tag as a TIFFField,
or null if the tag is not present.
|
| getFieldAsByte | | public byte getFieldAsByte(int tag, int index)(Code) | | Returns the value of a particular index of a given tag as a
byte. The caller is responsible for ensuring that the tag is
present and has type TIFFField.TIFF_SBYTE, TIFF_BYTE, or
TIFF_UNDEFINED.
|
| getFieldAsByte | | public byte getFieldAsByte(int tag)(Code) | | Returns the value of index 0 of a given tag as a
byte. The caller is responsible for ensuring that the tag is
present and has type TIFFField.TIFF_SBYTE, TIFF_BYTE, or
TIFF_UNDEFINED.
|
| getFieldAsDouble | | public double getFieldAsDouble(int tag, int index)(Code) | | Returns the value of a particular index of a given tag as a
double. The caller is responsible for ensuring that the tag is
present and has numeric type (all but TIFF_UNDEFINED and
TIFF_ASCII).
|
| getFieldAsDouble | | public double getFieldAsDouble(int tag)(Code) | | Returns the value of index 0 of a given tag as a double. The
caller is responsible for ensuring that the tag is present and
has numeric type (all but TIFF_UNDEFINED and TIFF_ASCII).
|
| getFieldAsFloat | | public float getFieldAsFloat(int tag, int index)(Code) | | Returns the value of a particular index of a given tag as a
float. The caller is responsible for ensuring that the tag is
present and has numeric type (all but TIFF_UNDEFINED and
TIFF_ASCII).
|
| getFieldAsFloat | | public float getFieldAsFloat(int tag)(Code) | | Returns the value of index 0 of a given tag as a float. The
caller is responsible for ensuring that the tag is present and
has numeric type (all but TIFF_UNDEFINED and TIFF_ASCII).
|
| getFieldAsLong | | public long getFieldAsLong(int tag, int index)(Code) | | Returns the value of a particular index of a given tag as a
long. The caller is responsible for ensuring that the tag is
present and has type TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED,
TIFF_SHORT, TIFF_SSHORT, TIFF_SLONG or TIFF_LONG.
|
| getFieldAsLong | | public long getFieldAsLong(int tag)(Code) | | Returns the value of index 0 of a given tag as a
long. The caller is responsible for ensuring that the tag is
present and has type TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED,
TIFF_SHORT, TIFF_SSHORT, TIFF_SLONG or TIFF_LONG.
|
| getFields | | public TIFFField[] getFields()(Code) | | Returns an array of TIFFFields containing all the fields
in this directory.
|
| getIFDOffset | | public long getIFDOffset()(Code) | | Returns the offset of the IFD corresponding to this
TIFFDirectory.
|
| getNextIFDOffset | | public long getNextIFDOffset()(Code) | | Returns the offset of the next IFD after the IFD corresponding to this
TIFFDirectory.
|
| getNumDirectories | | public static int getNumDirectories(SeekableStream stream) throws IOException(Code) | | Returns the number of image directories (subimages) stored in a
given TIFF file, represented by a SeekableStream.
|
| getNumEntries | | public int getNumEntries()(Code) | | Returns the number of directory entries.
|
| getTags | | public int[] getTags()(Code) | | Returns an ordered array of ints indicating the tag
values.
|
| isBigEndian | | public boolean isBigEndian()(Code) | | Returns a boolean indicating whether the byte order used in the
the TIFF file is big-endian. That is, whether the byte order is from
the most significant to the least significant.
|
| isTagPresent | | public boolean isTagPresent(int tag)(Code) | | Returns true if a tag appears in the directory.
|
|
|