org.apache.tika.parser
Interface Parser

All Known Implementing Classes:

AudioParser, AutoDetectParser, ClassParser, CompositeParser, DcXMLParser, DelegatingParser, EmptyParser, EpubContentParser, EpubParser, ErrorParser, ExternalParser, FLVParser, HtmlParser, ImageParser, JpegParser, MboxParser, MidiParser, Mp3Parser, OfficeParser, OOXMLParser, OpenDocumentContentParser, OpenDocumentMetaParser, OpenDocumentParser, OpenOfficeParser, PackageParser, ParserDecorator, ParserPostProcessor, PDFParser, RTFParser, TXTParser, XMLParser

public interface Parser

Tika parser interface.

Method Summary

java.util.Set<MediaType>	getSupportedTypes(ParseContext context) Returns the set of media types supported by this parser when used with the given parse context.
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata) Deprecated. This method will be removed in Apache Tika 1.0.
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context) Parses a document stream into a sequence of XHTML SAX events.

Method Detail

getSupportedTypes

java.util.Set<MediaType> getSupportedTypes(ParseContext context)

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

Since:

Apache Tika 0.7

parse

void parse(java.io.InputStream stream,
           org.xml.sax.ContentHandler handler,
           Metadata metadata,
           ParseContext context)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException

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:

java.io.IOException - if the document stream could not be read

org.xml.sax.SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

Since:

Apache Tika 0.5

parse

void parse(java.io.InputStream stream,
           org.xml.sax.ContentHandler handler,
           Metadata metadata)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException

Deprecated. This method will be removed in Apache Tika 1.0.

The parse() method from Tika 0.4 and earlier. Please use the parse(InputStream, ContentHandler, Metadata, ParseContext) method instead in new code. Calls to this backwards compatibility method are forwarded to the new parse() method with an empty parse context.

Throws:

java.io.IOException

org.xml.sax.SAXException

TikaException