Class TiffImageParser
- All Implemented Interfaces:
XmpEmbeddable
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionList<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 PrintWriterprotected String[]
Get an array of all accepted extensionsprotected ImageFormat[]
Get an array of ImageFormat objects describing all accepted typesgetAllBufferedImages
(ByteSource byteSource) Gets all images specified by the byte source (some formats may include multiple images within a single data source).getBufferedImage
(ByteSource byteSource, TiffImagingParameters params) Gets a buffered image specified by the byte source.protected BufferedImage
getBufferedImage
(TiffDirectory directory, ByteOrder byteOrder, TiffImagingParameters params) Get the default extension for the format specified by an implementation of ImageParser.Get a default parameters instance for this parser.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) Get an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource.getImageInfo
(ByteSource byteSource, TiffImagingParameters params) Get image information from the specified ByteSource.getImageSize
(ByteSource byteSource, TiffImagingParameters params) Get the size of the image described by the specified ByteSource.getMetadata
(ByteSource byteSource, TiffImagingParameters params) Get image metadata from the specified byte source.getName()
Get a descriptive name for the implementation of an ImageParser.getXmpXml
(ByteSource byteSource, XmpImagingParameters params) Get a string containing XML-formatted text conforming to the Extensible Metadata Platform (EXP) 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.ImageParser
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
-
Constructor Details
-
TiffImageParser
public TiffImageParser()
-
-
Method Details
-
getDefaultParameters
Description copied from class:ImageParser
Get a default parameters instance for this parser.- Specified by:
getDefaultParameters
in classImageParser<TiffImagingParameters>
- Returns:
- default parameters instance
-
getName
Description copied from class:ImageParser
Get a descriptive name for the implementation of an ImageParser.- Specified by:
getName
in classImageParser<TiffImagingParameters>
- Returns:
- a valid, subject-matter-specific string.
-
getDefaultExtension
Description copied from class:ImageParser
Get 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 classImageParser<TiffImagingParameters>
- Returns:
- A valid string.
-
getAcceptedExtensions
Description copied from class:ImageParser
Get an array of all accepted extensions- Specified by:
getAcceptedExtensions
in classImageParser<TiffImagingParameters>
- Returns:
- A valid array of one or more elements.
-
getAcceptedTypes
Description copied from class:ImageParser
Get an array of ImageFormat objects describing all accepted types- Specified by:
getAcceptedTypes
in classImageParser<TiffImagingParameters>
- Returns:
- A valid array of one or more elements.
-
getICCProfileBytes
public byte[] getICCProfileBytes(ByteSource byteSource, TiffImagingParameters params) throws ImageReadException, IOException Description copied from class:ImageParser
Get 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 classImageParser<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:
ImageReadException
- 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.
-
getImageSize
public Dimension getImageSize(ByteSource byteSource, TiffImagingParameters params) throws ImageReadException, IOException Description copied from class:ImageParser
Get the size of the image described by the specified ByteSource.- Specified by:
getImageSize
in classImageParser<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:
ImageReadException
- 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 ImageReadException, IOException Description copied from class:ImageParser
Get 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 classImageParser<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:
ImageReadException
- 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.
-
getImageInfo
public ImageInfo getImageInfo(ByteSource byteSource, TiffImagingParameters params) throws ImageReadException, IOException Description copied from class:ImageParser
Get 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 classImageParser<TiffImagingParameters>
- Parameters:
byteSource
- A valid ByteSource objectparams
- 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:
ImageReadException
- 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.
-
getXmpXml
public String getXmpXml(ByteSource byteSource, XmpImagingParameters params) throws ImageReadException, IOException Description copied from interface:XmpEmbeddable
Get a string containing XML-formatted text conforming to the Extensible Metadata Platform (EXP) standard for representing information about image content. Not all image formats support EXP information and even for those that do, there is no guarantee that such information will be present in an image.- Specified by:
getXmpXml
in interfaceXmpEmbeddable
- 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:
ImageReadException
- 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.
-
dumpImageFile
public boolean dumpImageFile(PrintWriter pw, ByteSource byteSource) throws ImageReadException, IOException Description copied from class:ImageParser
Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter- Overrides:
dumpImageFile
in classImageParser<TiffImagingParameters>
- Parameters:
pw
- print writer used for writing the ImageInfobyteSource
- A valid byte source.- Returns:
- A valid PrintWriter.
- Throws:
ImageReadException
- 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.
-
getFormatCompliance
public FormatCompliance getFormatCompliance(ByteSource byteSource) throws ImageReadException, IOException Description copied from class:ImageParser
Determines the format compliance of the content of the supplied byte source based on rules provided by a specific implementation.- Overrides:
getFormatCompliance
in classImageParser<TiffImagingParameters>
- Parameters:
byteSource
- A valid instance of ByteSource- Returns:
- true if the content is format-compliant; otherwise, false
- Throws:
ImageReadException
- may be thrown by sub-classesIOException
- may be thrown by sub-classes
-
collectRawImageData
public List<byte[]> collectRawImageData(ByteSource byteSource, TiffImagingParameters params) throws ImageReadException, IOException - Throws:
ImageReadException
IOException
-
getBufferedImage
public BufferedImage getBufferedImage(ByteSource byteSource, TiffImagingParameters params) throws ImageReadException, 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 classImageParser<TiffImagingParameters>
- Parameters:
byteSource
- A valid instance of ByteSourceparams
- 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:
ImageReadException
- 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.
-
getAllBufferedImages
public List<BufferedImage> getAllBufferedImages(ByteSource byteSource) throws ImageReadException, IOException Description copied from class:ImageParser
Gets all images specified by the byte source (some formats may include multiple images within a single data source).- Overrides:
getAllBufferedImages
in classImageParser<TiffImagingParameters>
- Parameters:
byteSource
- A valid instance of ByteSource.- Returns:
- A valid (potentially empty) list of BufferedImage objects.
- Throws:
ImageReadException
- 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 ImageReadException, IOException - Throws:
ImageReadException
IOException
-
writeImage
public void writeImage(BufferedImage src, OutputStream os, TiffImagingParameters params) throws ImageWriteException, IOException Description copied from class:ImageParser
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 classImageParser<TiffImagingParameters>
- Parameters:
src
- An image giving the source content for outputos
- A valid output stream for storing the formatted imageparams
- optional parameters, defining format-specific instructions for output (such as selections for data compression, color models, etc.)- Throws:
ImageWriteException
- 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.
-