Package org.apache.commons.imaging.formats.tiff

Class TiffImageParser

java.lang.Object

org.apache.commons.imaging.common.BinaryFileParser

org.apache.commons.imaging.AbstractImageParser<TiffImagingParameters>

org.apache.commons.imaging.formats.tiff.TiffImageParser

All Implemented Interfaces:

XmpEmbeddable<TiffImagingParameters>

public class TiffImageParser
extends AbstractImageParser<TiffImagingParameters>
implements XmpEmbeddable<TiffImagingParameters>

Implements methods for reading and writing TIFF files. Instances of this class are invoked from the general Imaging class. Applications that require the use of TIFF-specific features may instantiate and access this class directly.

Constructor Summary

Constructors

Constructor	Description
TiffImageParser()

Method Summary

Modifier and Type	Method	Description
List<byte[]>	collectRawImageData(ByteSource byteSource, TiffImagingParameters params)
boolean	dumpImageFile(PrintWriter pw, ByteSource byteSource)	Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter
protected String[]	getAcceptedExtensions()	Gets an array of all accepted extensions
protected ImageFormat[]	getAcceptedTypes()	Gets an array of ImageFormat objects describing all accepted types
List<BufferedImage>	getAllBufferedImages(ByteSource byteSource)	Gets all images specified by the byte source (some formats may include multiple images within a single data source).
BufferedImage	getBufferedImage(ByteSource byteSource, TiffImagingParameters params)	Gets a buffered image specified by the byte source.
protected BufferedImage	getBufferedImage(TiffDirectory directory, ByteOrder byteOrder, TiffImagingParameters params)
String	getDefaultExtension()	Gets the default extension for the format specified by an implementation of ImageParser.
TiffImagingParameters	getDefaultParameters()	Gets a default parameters instance for this parser.
FormatCompliance	getFormatCompliance(ByteSource byteSource)	Determines the format compliance of the content of the supplied byte source based on rules provided by a specific implementation.
byte[]	getIccProfileBytes(ByteSource byteSource, TiffImagingParameters params)	Gets an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource.
ImageInfo	getImageInfo(ByteSource byteSource, TiffImagingParameters params)	Gets image information from the specified ByteSource.
Dimension	getImageSize(ByteSource byteSource, TiffImagingParameters params)	Gets the size of the image described by the specified ByteSource.
ImageMetadata	getMetadata(ByteSource byteSource, TiffImagingParameters params)	Gets image metadata from the specified byte source.
String	getName()	Gets a descriptive name for the implementation of an ImageParser.
String	getXmpXml(ByteSource byteSource, XmpImagingParameters<TiffImagingParameters> params)	Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content.
void	writeImage(BufferedImage src, OutputStream os, TiffImagingParameters params)	Writes the content of a BufferedImage to the specified output stream.

Methods inherited from class org.apache.commons.imaging.AbstractImageParser

canAcceptExtension, canAcceptExtension, canAcceptType, dumpImageFile, dumpImageFile, dumpImageFile, getAllBufferedImages, getAllBufferedImages, getAllImageParsers, getBufferedImage, getBufferedImage, getBufferedImageFactory, getFormatCompliance, getFormatCompliance, getIccProfileBytes, getIccProfileBytes, getIccProfileBytes, getIccProfileBytes, getImageInfo, getImageInfo, getImageInfo, getImageSize, getImageSize, getImageSize, getImageSize, getMetadata, getMetadata, getMetadata, getMetadata, getMetadata

Methods inherited from class org.apache.commons.imaging.common.BinaryFileParser

debugNumber, debugNumber, getByteOrder, setByteOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TiffImageParser

public TiffImageParser()

Method Details

collectRawImageData

public List<byte[]> collectRawImageData(ByteSource byteSource,
 TiffImagingParameters params)
                                 throws ImagingException,
IOException

Throws:

ImagingException

IOException

dumpImageFile

public boolean dumpImageFile(PrintWriter pw,
 ByteSource byteSource)
                      throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter

Overrides:

dumpImageFile in class AbstractImageParser<TiffImagingParameters>

Parameters:

pw - print writer used for writing the ImageInfo

byteSource - A valid byte source.

Returns:

A valid PrintWriter.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getAcceptedExtensions

protected String[] getAcceptedExtensions()

Description copied from class: AbstractImageParser

Gets an array of all accepted extensions

Specified by:

getAcceptedExtensions in class AbstractImageParser<TiffImagingParameters>

Returns:

A valid array of one or more elements.

getAcceptedTypes

protected ImageFormat[] getAcceptedTypes()

Description copied from class: AbstractImageParser

Gets an array of ImageFormat objects describing all accepted types

Specified by:

getAcceptedTypes in class AbstractImageParser<TiffImagingParameters>

Returns:

A valid array of one or more elements.

getAllBufferedImages

public List<BufferedImage> getAllBufferedImages(ByteSource byteSource)
                                         throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets all images specified by the byte source (some formats may include multiple images within a single data source).

Overrides:

getAllBufferedImages in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid instance of ByteSource.

Returns:

A valid (potentially empty) list of BufferedImage objects.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getBufferedImage

public BufferedImage getBufferedImage(ByteSource byteSource,
 TiffImagingParameters params)
                               throws ImagingException,
IOException

Gets a buffered image specified by the byte source. The TiffImageParser class features support for a number of options that are unique to the TIFF format. These options can be specified by supplying the appropriate parameters using the keys from the TiffConstants class and the params argument for this method.

Loading Partial Images

The TIFF parser includes support for loading partial images without committing significantly more memory resources than are necessary to store the image. This feature is useful for conserving memory in applications that require a relatively small sub image from a very large TIFF file. The specifications for partial images are as follows:

 TiffImagingParameters params = new TiffImagingParameters();
 params.setSubImageX(x);
 params.setSubImageY(y);
 params.setSubImageWidth(width);
 params.setSubImageHeight(height);
 

Note that the arguments x, y, width, and height must specify a valid rectangular region that is fully contained within the source TIFF image.

Specified by:

getBufferedImage in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid instance of ByteSource

params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).

Returns:

A valid instance of BufferedImage.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getBufferedImage

protected BufferedImage getBufferedImage(TiffDirectory directory,
 ByteOrder byteOrder,
 TiffImagingParameters params)
                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException

getDefaultExtension

public String getDefaultExtension()

Description copied from class: AbstractImageParser

Gets the default extension for the format specified by an implementation of ImageParser. Some parsers can support more than one extension (i.e. .JPEG, .JPG; .TIF, .TIFF, etc.).

Specified by:

getDefaultExtension in class AbstractImageParser<TiffImagingParameters>

Returns:

A valid string.

getDefaultParameters

public TiffImagingParameters getDefaultParameters()

Description copied from class: AbstractImageParser

Gets a default parameters instance for this parser.

Specified by:

getDefaultParameters in class AbstractImageParser<TiffImagingParameters>

Returns:

default parameters instance

getFormatCompliance

public FormatCompliance getFormatCompliance(ByteSource byteSource)
                                     throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Determines the format compliance of the content of the supplied byte source based on rules provided by a specific implementation.

Overrides:

getFormatCompliance in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid instance of ByteSource

Returns:

true if the content is format-compliant; otherwise, false

Throws:

ImagingException - may be thrown by sub-classes

IOException - may be thrown by sub-classes

getIccProfileBytes

public byte[] getIccProfileBytes(ByteSource byteSource,
 TiffImagingParameters params)
                          throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource. Not all formats support ICC profiles.

Specified by:

getIccProfileBytes in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid ByteSource.

params - Optional instructions for special-handling or interpretation of the input data.

Returns:

If available, a valid array of bytes; otherwise, a null

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getImageInfo

public ImageInfo getImageInfo(ByteSource byteSource,
 TiffImagingParameters params)
                       throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets image information from the specified ByteSource. Format-specific ImageParser implementations are expected to return a valid ImageInfo object or to throw an ImageReadException if unable to process the specified data.

The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

Specified by:

getImageInfo in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid ByteSource object

params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).

Returns:

A valid image information object describing the content extracted from the specified data.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful data access operation.

getImageSize

public Dimension getImageSize(ByteSource byteSource,
 TiffImagingParameters params)
                       throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets the size of the image described by the specified ByteSource.

Specified by:

getImageSize in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid reference to a ByteSource.

params - Optional instructions for special-handling or interpretation of the input data.

Returns:

A valid instance of Dimension.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

getMetadata

public ImageMetadata getMetadata(ByteSource byteSource,
 TiffImagingParameters params)
                          throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Gets image metadata from the specified byte source. Format-specific ImageParser implementations are expected to return a valid IImageMetadata object or to throw an ImageReadException if unable to process the specified byte source.

The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

Specified by:

getMetadata in class AbstractImageParser<TiffImagingParameters>

Parameters:

byteSource - A valid byte source.

params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).

Returns:

A valid, potentially subject-matter-specific implementation of the IImageMetadata interface describing the content extracted from the source content.

Throws:

ImagingException - In the event that the ByteSource content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful data read operation.

getName

public String getName()

Description copied from class: AbstractImageParser

Gets a descriptive name for the implementation of an ImageParser.

Specified by:

getName in class AbstractImageParser<TiffImagingParameters>

Returns:

a valid, subject-matter-specific string.

getXmpXml

public String getXmpXml(ByteSource byteSource,
 XmpImagingParameters<TiffImagingParameters> params)
                 throws ImagingException,
IOException

Description copied from interface: XmpEmbeddable

Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content. Not all image formats support XMP information and even for those that do, there is no guarantee that such information will be present in an image.

Specified by:

getXmpXml in interface XmpEmbeddable<TiffImagingParameters>

Parameters:

byteSource - A valid reference to a ByteSource.

params - Optional instructions for special-handling or interpretation of the input data.

Returns:

If XMP metadata is present, a valid string; if it is not present, a null.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

IOException - In the event of unsuccessful read or access operation.

writeImage

public void writeImage(BufferedImage src,
 OutputStream os,
 TiffImagingParameters params)
                throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Writes the content of a BufferedImage to the specified output stream.

The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will support this capability. Currently, some of the parsers do not check for null arguments.

Overrides:

writeImage in class AbstractImageParser<TiffImagingParameters>

Parameters:

src - An image giving the source content for output

os - A valid output stream for storing the formatted image

params - optional parameters, defining format-specific instructions for output (such as selections for data compression, color models, etc.)

Throws:

ImagingException - In the event that the output format cannot handle the input image or invalid params are specified.

IOException - In the event of an write error from the output stream.