Package org.apache.tika.parser.image

Class ImageMetadataExtractor

java.lang.Object

org.apache.tika.parser.image.ImageMetadataExtractor

public class ImageMetadataExtractor
extends Object

Uses the Metadata Extractor library to read EXIF and IPTC image metadata and map to Tika fields.

As of 2.4.0 the library supports jpeg and tiff. As of 2.8.0 the library supports webp.

Field Summary

Fields

Modifier and Type	Field	Description
static final KeyPrefix	ICC
static final String	ICC_NS
static final KeyPrefix	UNKNOWN_IMG
static final String	UNKNOWN_IMG_NS

Constructor Summary

Constructors

Constructor	Description
ImageMetadataExtractor(Metadata metadata)
ImageMetadataExtractor(Metadata metadata, ImageMetadataConfig config)
ImageMetadataExtractor(Metadata metadata, org.apache.tika.parser.image.ImageMetadataExtractor.DirectoryHandler... handlers)

Method Summary

Modifier and Type	Method	Description
protected void	handle(com.drew.metadata.Metadata metadataExtractor)	Copies extracted tags to tika metadata using registered handlers.
protected void	handle(Iterator<com.drew.metadata.Directory> directories)	Copies extracted tags to tika metadata using registered handlers.
void	parseHeif(InputStream is)
void	parseJpeg(File file)
void	parseJpeg(InputStream stream)
void	parseJpeg(TikaInputStream tis)	Reads from the file when one already exists (that path also yields metadata-extractor's file-system tags: img:File Name/Size/Modified Date, which describe the file, not the image), and from the stream otherwise.
void	parseRawExif(byte[] exifData)
void	parseRawExif(InputStream stream, int length, boolean needsExifHeader)
void	parseTiff(File file)
void	parseTiff(TikaInputStream tis)	TIFF needs random access.
void	parseWebP(File file)
void	parseWebP(InputStream stream)
void	parseWebP(TikaInputStream tis)	See parseJpeg(TikaInputStream); WebP is read sequentially too.

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_IMG_NS

public static final String UNKNOWN_IMG_NS

See Also:

• Constant Field Values

ICC_NS

public static final String ICC_NS

See Also:

• Constant Field Values

UNKNOWN_IMG

public static final KeyPrefix UNKNOWN_IMG

ICC

public static final KeyPrefix ICC

Constructor Details

ImageMetadataExtractor

public ImageMetadataExtractor(Metadata metadata)

Parameters:

metadata - to extract to, using default directory handlers and options

ImageMetadataExtractor

public ImageMetadataExtractor(Metadata metadata,
 ImageMetadataConfig config)

Parameters:

metadata - to extract to, using default directory handlers

config - options for the default handlers

ImageMetadataExtractor

public ImageMetadataExtractor(Metadata metadata,
 org.apache.tika.parser.image.ImageMetadataExtractor.DirectoryHandler... handlers)

Parameters:

metadata - to extract to

handlers - handlers in order, note that handlers may override values from earlier handlers

Method Details

parseJpeg

public void parseJpeg(TikaInputStream tis)
               throws IOException,
SAXException,
TikaException

Reads from the file when one already exists (that path also yields metadata-extractor's file-system tags: img:File Name/Size/Modified Date, which describe the file, not the image), and from the stream otherwise. JPEG is read sequentially, so the stream costs no extra memory.

Throws:

IOException

SAXException

TikaException

parseTiff

public void parseTiff(TikaInputStream tis)
               throws IOException,
SAXException,
TikaException

TIFF needs random access. In-memory content is read in place through a zero-copy view; anything else is read from the file. There is deliberately no InputStream overload: metadata-extractor's stream reader retains everything it reads.

Throws:

IOException

SAXException

TikaException

parseWebP

public void parseWebP(TikaInputStream tis)
               throws IOException,
TikaException

See parseJpeg(TikaInputStream); WebP is read sequentially too.

Throws:

IOException

TikaException

parseJpeg

public void parseJpeg(File file)
               throws IOException,
SAXException,
TikaException

Throws:

IOException

SAXException

TikaException

parseJpeg

public void parseJpeg(InputStream stream)
               throws IOException,
SAXException,
TikaException

Throws:

IOException

SAXException

TikaException

parseTiff

public void parseTiff(File file)
               throws IOException,
SAXException,
TikaException

Throws:

IOException

SAXException

TikaException

parseWebP

public void parseWebP(File file)
               throws IOException,
TikaException

Throws:

IOException

TikaException

parseWebP

public void parseWebP(InputStream stream)
               throws IOException,
TikaException

Throws:

IOException

TikaException

parseHeif

public void parseHeif(InputStream is)
               throws IOException,
TikaException

Throws:

IOException

TikaException

parseRawExif

public void parseRawExif(InputStream stream,
 int length,
 boolean needsExifHeader)
                  throws IOException,
SAXException,
TikaException

Throws:

IOException

SAXException

TikaException

parseRawExif

public void parseRawExif(byte[] exifData)
                  throws IOException,
SAXException,
TikaException

Throws:

IOException

SAXException

TikaException

handle

protected void handle(com.drew.metadata.Metadata metadataExtractor)
               throws com.drew.metadata.MetadataException

Copies extracted tags to tika metadata using registered handlers.

Parameters:

metadataExtractor - Tag directories from a Metadata Extractor "reader"

Throws:

com.drew.metadata.MetadataException - This method does not handle exceptions from Metadata Extractor

handle

protected void handle(Iterator<com.drew.metadata.Directory> directories)
               throws com.drew.metadata.MetadataException

Copies extracted tags to tika metadata using registered handlers.

Parameters:

directories - Metadata Extractor Directory instances.

Throws:

com.drew.metadata.MetadataException - This method does not handle exceptions from Metadata Extractor