Package org.apache.tika.parser.iwork

Class IWorkPackageParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.iwork.IWorkPackageParser

All Implemented Interfaces:

Serializable, Parser

public class IWorkPackageParser
extends AbstractParser

A parser for the IWork container files. This includes *.key, *.pages and *.numbers files. This parser delegates the relevant entries to a ContentHandler that parsers the content. Currently supported formats:

1. Keynote format version 2.x. Currently only tested with Keynote version 5.x
2. Pages format version 1.x. Currently only tested with Pages version 4.0.x
3. Numbers format version 1.x. Currently only tested with Numbers version 2.0.x

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IWorkPackageParser.IWORKDocumentType

Field Summary

Fields

Modifier and Type	Field	Description
static String	IWORK_COMMON_ENTRY	All iWork files contain one of these, so we can detect based on it
static Set<String>	IWORK_CONTENT_ENTRIES	Which files within an iWork file contain the actual content?

Constructor Summary

Constructors

Constructor	Description
IWorkPackageParser()

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.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Field Detail

IWORK_CONTENT_ENTRIES

public static final Set<String> IWORK_CONTENT_ENTRIES

Which files within an iWork file contain the actual content?

IWORK_COMMON_ENTRY

public static final String IWORK_COMMON_ENTRY

All iWork files contain one of these, so we can detect based on it

See Also:

Constant Field Values

Constructor Detail

IWorkPackageParser

public IWorkPackageParser()

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.

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