org.apache.tika.parser

Interface Parser

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractEncodingDetectorParser, AbstractOfficeParser, AbstractParser, AbstractXML2003Parser, AdobeFontMetricParser, AgeRecogniser, AppleSingleFileParser, AudioParser, AutoDetectParser, BPGParser, ChmParser, ClassParser, CompositeExternalParser, CompositeParser, CompressorParser, CryptoParser, CTAKESParser, DBFParser, DcXMLParser, DefaultParser, DelegatingParser, DIFParser, DigestingParser, DirListParser, DWGParser, EMFParser, EmptyParser, EncryptedPrescriptionParser, EnviHeaderParser, EpubContentParser, EpubParser, ErrorParser, ExecutableParser, ExternalParser, FeedParser, FictionBookParser, FLVParser, ForkParser, GDALParser, GeographicInformationParser, GeoParser, GribParser, HDFParser, HtmlParser, ICNSParser, ImageParser, IptcAnpaParser, ISArchiveParser, IWork13PackageParser, IWorkPackageParser, JackcessParser, JournalParser, JpegParser, LanguageDetectingParser, Latin1StringsParser, MatParser, MboxParser, MidiParser, Mp3Parser, MP4Parser, MSOwnerFileParser, NamedEntityParser, NetCDFParser, NetworkParser, ObjectRecognitionParser, OfficeParser, OldExcelParser, OOXMLParser, OpenDocumentContentParser, OpenDocumentMetaParser, OpenDocumentParser, OpenOfficeParser, OutlookPSTParser, PackageParser, ParserDecorator, ParserPostProcessor, PDFParser, Pkcs7Parser, PooledTimeSeriesParser, PrescriptionParser, PRTParser, PSDParser, QuattroProParser, RarParser, RecursiveParserWrapper, RFC822Parser, RTFParser, SentimentAnalysisParser, SourceCodeParser, SpreadsheetMLParser, SQLite3Parser, StringsParser, TensorflowImageRecParser, TesseractOCRParser, TiffParser, TNEFParser, TrueTypeParser, TSDParser, TXTParser, WebPParser, WMFParser, Word2006MLParser, WordMLParser, WordPerfectParser, XMLParser

public interface Parser
extends Serializable

Tika parser interface.

See Also:

for parsers which adopts to runtime params

Method Summary

Modifier and Type	Method and 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.

Method Detail

getSupportedTypes

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(InputStream stream,
           ContentHandler handler,
           Metadata metadata,
           ParseContext context)
    throws IOException,
           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:

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

Since:

Apache Tika 0.5