Package org.apache.tika.parser.xml

Class XMLProfiler

java.lang.Object

org.apache.tika.parser.xml.XMLProfiler

All Implemented Interfaces:

Serializable, Parser

public class XMLProfiler
extends Object
implements Parser

This parser enables profiling of XML. It captures the root entity as well as entity uris/namespaces and entity local names in parallel arrays.

This parser is not part of the default set of parsers and must be "turned on" via a tika config:

<properties> <parsers> <parser class="org.apache.tika.parser.DefaultParser"/> <parser class="org.apache.tika.parser.xml.XMLProfiler"/> </parsers> </properties>

This was initially designed to profile xmp and xfa in PDFs. Further work would need to be done to extract other types of xml and/or xmp in other file formats. Please open a ticket.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Property	ENTITY_LOCAL_NAMES
static Property	ENTITY_URIS
static Property	ROOT_ENTITY

Constructor Summary

Constructors

Constructor	Description
XMLProfiler()

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ENTITY

public static Property ROOT_ENTITY

ENTITY_URIS

public static Property ENTITY_URIS

ENTITY_LOCAL_NAMES

public static Property ENTITY_LOCAL_NAMES

Constructor Detail

XMLProfiler

public XMLProfiler()

Method Detail

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(InputStream stream,
                  ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws IOException,
                  SAXException,
                  TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

Parameters:

stream - the document stream (input)

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

IOException - if the document stream could not be read

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed