org.apache.tika.parser.image.xmp

Class XMPPacketScanner

java.lang.Object

org.apache.tika.parser.image.xmp.XMPPacketScanner

public class XMPPacketScanner
extends Object

This class is a parser for XMP packets. By default, it tries to locate the first XMP packet it finds and parses it.

Important: Before you use this class to look for an XMP packet in some random file, please read the chapter on "Scanning Files for XMP Packets" in the XMP specification!

Thic class was branched from http://xmlgraphics.apache.org/ XMPPacketParser. See also org.semanticdesktop.aperture.extractor.xmp.XMPExtractor, a variant.

Constructor Summary

Constructors

Constructor and Description
XMPPacketScanner()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	parse(InputStream in, OutputStream xmlOut) Locates an XMP packet in a stream, parses it and returns the XMP metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMPPacketScanner

public XMPPacketScanner()

Method Detail

parse

public boolean parse(InputStream in,
            OutputStream xmlOut)
              throws IOException

Locates an XMP packet in a stream, parses it and returns the XMP metadata. If no XMP packet is found until the stream ends, null is returned. Note: This method only finds the first XMP packet in a stream. And it cannot determine whether it has found the right XMP packet if there are multiple packets. Does not close the stream. If XMP block was found reading can continue below the block.

Parameters:

in - the InputStream to search

xmlOut - to write the XMP packet to

Returns:

true if XMP packet is found, false otherwise

Throws:

IOException - if an I/O error occurs

TransformerException - if an error occurs while parsing the XMP packet