Package org.apache.tika.parser.microsoft.ooxml

Class OOXMLParser

java.lang.Object

org.apache.tika.parser.microsoft.AbstractOfficeParser

org.apache.tika.parser.microsoft.ooxml.OOXMLParser

All Implemented Interfaces:

Serializable, Parser

public class OOXMLParser
extends AbstractOfficeParser

Office Open XML (OOXML) parser.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	SIGNATURE_RELATIONSHIP
protected static final Set<MediaType>	SUPPORTED_TYPES
protected static final Set<MediaType>	UNSUPPORTED_OOXML_TYPES	We claim to support all OOXML files, but we actually don't support a small number of them.
protected static final MediaType	XPS

Constructor Summary

Constructors

Constructor	Description
OOXMLParser()

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 org.apache.tika.parser.microsoft.AbstractOfficeParser

configure, getByteArrayMaxOverride, getDateFormatOverride, isConcatenatePhoneticRuns, isExtractAllAlternativesFromMSG, isExtractMacros, isIncludeDeletedContent, isIncludeHeadersAndFooters, isIncludeMoveFromContent, isIncludeShapeBasedContent, isUseSAXDocxExtractor, isUseSAXPptxExtractor, setByteArrayMaxOverride, setConcatenatePhoneticRuns, setDateFormatOverride, setExtractAllAlternativesFromMSG, setExtractMacros, setIncludeDeletedContent, setIncludeHeadersAndFooters, setIncludeMoveFromContent, setIncludeShapeBasedContent, setUseSAXDocxExtractor, setUseSAXPptxExtractor

Methods inherited from class java.lang.Object

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

Field Details

SIGNATURE_RELATIONSHIP

protected static final String SIGNATURE_RELATIONSHIP

See Also:

• Constant Field Values

XPS

protected static final MediaType XPS

SUPPORTED_TYPES

protected static final Set<MediaType> SUPPORTED_TYPES

UNSUPPORTED_OOXML_TYPES

protected static final Set<MediaType> UNSUPPORTED_OOXML_TYPES

We claim to support all OOXML files, but we actually don't support a small number of them. This list is used to decline certain formats that are not yet supported by Tika and/or POI.

Constructor Details

OOXMLParser

public OOXMLParser()

Method Details

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.

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.

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