Save This Page
Home » iText-2.1.7 » com.lowagie » text » pdf » codec » [javadoc | source]
com.lowagie.text.pdf.codec
public class: TIFFDirectory [javadoc | source]
java.lang.Object
   com.lowagie.text.pdf.codec.TIFFDirectory

All Implemented Interfaces:
    Serializable

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.

Field Summary
 boolean isBigEndian    A boolean storing the endianness of the stream. 
 int numEntries    The number of entries in the IFD. 
 TIFFField[] fields    An array of TIFFFields. 
 Hashtable fieldIndex    A Hashtable indexing the fields by tag number. 
 long IFDOffset    The offset of this IFD. 
 long nextIFDOffset    The offset of the next IFD. 
Constructor:
 TIFFDirectory() 
 public TIFFDirectory(RandomAccessFileOrArray stream,
    int directory) throws IOException 
    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 maintaining multiple directories.
    Parameters:
    stream - a SeekableStream to read from.
    directory - the index of the directory to read.
 public TIFFDirectory(RandomAccessFileOrArray stream,
    long ifd_offset,
    int directory) throws IOException 
    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.
    ifd_offset - the long byte offset of the directory.
    directory - the index of the directory to read beyond the one at the current stream offset; zero indicates the IFD at the current offset.
Method from com.lowagie.text.pdf.codec.TIFFDirectory Summary:
getField,   getFieldAsByte,   getFieldAsByte,   getFieldAsDouble,   getFieldAsDouble,   getFieldAsFloat,   getFieldAsFloat,   getFieldAsLong,   getFieldAsLong,   getFields,   getIFDOffset,   getNextIFDOffset,   getNumDirectories,   getNumEntries,   getTags,   isBigEndian,   isTagPresent
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.lowagie.text.pdf.codec.TIFFDirectory Detail:
 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) 
    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.
 public byte getFieldAsByte(int tag,
    int index) 
    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.
 public double getFieldAsDouble(int tag) 
    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).
 public double getFieldAsDouble(int tag,
    int index) 
    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).
 public float getFieldAsFloat(int tag) 
    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).
 public float getFieldAsFloat(int tag,
    int index) 
    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).
 public long getFieldAsLong(int tag) 
    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.
 public long getFieldAsLong(int tag,
    int index) 
    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.
 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(RandomAccessFileOrArray stream) throws IOException 
    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 (i.e. whether the byte order is from the most significant to the least significant)
 public boolean isTagPresent(int tag) 
    Returns true if a tag appears in the directory.