Uses of Interface
org.apache.tika.parser.Parser

Packages that use Parser

Package	Description
org.apache.tika	Apache Tika.
org.apache.tika.config	Tika configuration tools.
org.apache.tika.extractor	Extraction of component documents.
org.apache.tika.fork	Forked parser.
org.apache.tika.parser	Tika parsers.
org.apache.tika.parser.external	External parser process.
org.apache.tika.parser.external2
org.apache.tika.parser.multiple
org.apache.tika.utils	Utilities.

Uses of Parser in org.apache.tika

Methods in org.apache.tika that return Parser

Modifier and Type	Method	Description
Parser	Tika.getParser()	Returns the parser instance used by this facade.

Constructors in org.apache.tika with parameters of type Parser

Constructor	Description
Tika(Detector detector, Parser parser)	Creates a Tika facade using the given detector and parser instances, but the default Translator.
Tika(Detector detector, Parser parser, Translator translator)	Creates a Tika facade using the given detector, parser, and translator instances.

Uses of Parser in org.apache.tika.config

Methods in org.apache.tika.config that return Parser

Modifier and Type	Method	Description
Parser	TikaConfig.getParser()	Returns the configured parser instance.

Uses of Parser in org.apache.tika.extractor

Methods in org.apache.tika.extractor that return Parser

Modifier and Type	Method	Description
Parser	ParsingEmbeddedDocumentExtractor.getDelegatingParser()
static Parser	EmbeddedDocumentUtil.getStatelessParser(ParseContext context)	Utility function to get the Parser that was sent in to the ParseContext to handle embedded documents.
static Parser	EmbeddedDocumentUtil.tryToFindExistingLeafParser(Class clazz, ParseContext context)	Tries to find an existing parser within the ParseContext.

Constructors in org.apache.tika.extractor with parameters of type Parser

Constructor	Description
ParserContainerExtractor(Parser parser, Detector detector)

Uses of Parser in org.apache.tika.fork

Classes in org.apache.tika.fork that implement Parser

Modifier and Type	Class	Description
class	ForkParser

Constructors in org.apache.tika.fork with parameters of type Parser

Constructor	Description
ForkParser(ClassLoader loader, Parser parser)

Uses of Parser in org.apache.tika.parser

Classes in org.apache.tika.parser that implement Parser

Modifier and Type	Class	Description
class	AbstractEncodingDetectorParser	Abstract base class for parsers that use the AutoDetectReader and need to use the EncodingDetector configured by TikaConfig
class	AbstractExternalProcessParser	Abstract base class for parsers that call external processes.
class	AbstractParser	Deprecated. for removal in 4.x
class	AutoDetectParser
class	CompositeParser	Composite parser that delegates parsing tasks to a component parser based on the declared content type of the incoming document.
class	CryptoParser	Decrypts the incoming document stream and delegates further parsing to another parser instance.
class	DefaultParser	A composite parser based on all the Parser implementations available through the service provider mechanism.
class	DelegatingParser	Base class for parser implementations that want to delegate parts of the task of parsing an input document to another parser.
class	DigestingParser
class	EmptyParser	Dummy parser that always produces an empty XHTML document without even attempting to parse the given document stream.
class	ErrorParser	Dummy parser that always throws a TikaException without even attempting to parse the given document stream.
class	NetworkParser
class	ParserDecorator	Decorator base class for the Parser interface.
class	ParserPostProcessor	Parser decorator that post-processes the results from a decorated parser.
class	RecursiveParserWrapper	This is a helper class that wraps a parser in a recursive handler.
class	RegexCaptureParser
class	StatefulParser	The RecursiveParserWrapper wraps the parser sent into the parsecontext and then uses that parser to store state (among many other things).

Methods in org.apache.tika.parser that return Parser

Modifier and Type	Method	Description
Parser	AutoDetectParserFactory.build()
abstract Parser	ParserFactory.build()
protected Parser	DelegatingParser.getDelegateParser(ParseContext context)	Returns the parser instance to which parsing tasks should be delegated.
Parser	CompositeParser.getFallback()	Returns the fallback parser.
protected Parser	CompositeParser.getParser(Metadata metadata)	Returns the parser that best matches the given metadata.
protected Parser	CompositeParser.getParser(Metadata metadata, ParseContext context)
Parser	ParserDecorator.getWrappedParser()	Gets the parser wrapped by this ParserDecorator
static Parser	ParserDecorator.withFallbacks(Collection<? extends Parser> parsers, Set<MediaType> types)	Deprecated. This has been replaced by FallbackParser
static Parser	ParserDecorator.withoutTypes(Parser parser, Set<MediaType> excludeTypes)	Decorates the given parser so that it never claims to support parsing of the given media types, but will work for all others.
static Parser	ParserDecorator.withTypes(Parser parser, Set<MediaType> types)	Decorates the given parser so that it always claims to support parsing of the given media types.

Methods in org.apache.tika.parser that return types with arguments of type Parser

Modifier and Type	Method	Description
Map<MediaType,List<Parser>>	CompositeParser.findDuplicateParsers(ParseContext context)	Utility method that goes through all the component parsers and finds all media types for which more than one parser declares support.
List<Parser>	CompositeParser.getAllComponentParsers()	Returns all parsers registered with the Composite Parser, including ones which may not currently be active.
List<Parser>	DefaultParser.getAllComponentParsers()
Map<MediaType,Parser>	CompositeParser.getParsers()	Returns the component parsers.
Map<MediaType,Parser>	CompositeParser.getParsers(ParseContext context)
Map<MediaType,Parser>	DefaultParser.getParsers(ParseContext context)

Methods in org.apache.tika.parser with parameters of type Parser

Modifier and Type	Method	Description
void	CompositeParser.setFallback(Parser fallback)	Sets the fallback parser.
static Parser	ParserDecorator.withoutTypes(Parser parser, Set<MediaType> excludeTypes)	Decorates the given parser so that it never claims to support parsing of the given media types, but will work for all others.
static Parser	ParserDecorator.withTypes(Parser parser, Set<MediaType> types)	Decorates the given parser so that it always claims to support parsing of the given media types.

Method parameters in org.apache.tika.parser with type arguments of type Parser

Modifier and Type	Method	Description
void	CompositeParser.setParsers(Map<MediaType,Parser> parsers)	Sets the component parsers.
static Parser	ParserDecorator.withFallbacks(Collection<? extends Parser> parsers, Set<MediaType> types)	Deprecated. This has been replaced by FallbackParser

Constructors in org.apache.tika.parser with parameters of type Parser

Constructor	Description
AutoDetectParser(Detector detector, Parser... parsers)
AutoDetectParser(Parser... parsers)	Creates an auto-detecting parser instance using the specified set of parser.
CompositeParser(MediaTypeRegistry registry, Parser... parsers)
DigestingParser(Parser parser, DigestingParser.Digester digester, boolean skipContainerDocument)	Creates a decorator for the given parser.
ParserDecorator(Parser parser)	Creates a decorator for the given parser.
ParserPostProcessor(Parser parser)	Creates a post-processing decorator for the given parser.
ParsingReader(Parser parser, InputStream stream, Metadata metadata, ParseContext context)	Creates a reader for the text content of the given binary stream with the given document metadata.
ParsingReader(Parser parser, InputStream stream, Metadata metadata, ParseContext context, Executor executor)	Creates a reader for the text content of the given binary stream with the given document metadata.
RecursiveParserWrapper(Parser wrappedParser)	Initialize the wrapper with RecursiveParserWrapper.catchEmbeddedExceptions set to true as default.
RecursiveParserWrapper(Parser wrappedParser, boolean catchEmbeddedExceptions)
StatefulParser(Parser parser)	Creates a decorator for the given parser.

Constructor parameters in org.apache.tika.parser with type arguments of type Parser

Constructor	Description
CompositeParser(MediaTypeRegistry registry, List<Parser> parsers)
CompositeParser(MediaTypeRegistry registry, List<Parser> parsers, Collection<Class<? extends Parser>> excludeParsers)
CompositeParser(MediaTypeRegistry registry, List<Parser> parsers, Collection<Class<? extends Parser>> excludeParsers)
DefaultParser(MediaTypeRegistry registry, ServiceLoader loader, Collection<Class<? extends Parser>> excludeParsers)
DefaultParser(MediaTypeRegistry registry, ServiceLoader loader, Collection<Class<? extends Parser>> excludeParsers, EncodingDetector encodingDetector, Renderer renderer)

Uses of Parser in org.apache.tika.parser.external

Classes in org.apache.tika.parser.external that implement Parser

Modifier and Type	Class	Description
class	CompositeExternalParser	A Composite Parser that wraps up all the available External Parsers, and provides an easy way to access them.
class	ExternalParser	Parser that uses an external program (like catdoc or pdf2txt) to extract text content and metadata from a given document.

Uses of Parser in org.apache.tika.parser.external2

Classes in org.apache.tika.parser.external2 that implement Parser

Modifier and Type	Class	Description
class	ExternalParser	This is a next generation external parser that uses some of the more recent additions to Tika.

Methods in org.apache.tika.parser.external2 that return Parser

Modifier and Type	Method	Description
Parser	ExternalParser.getOutputParser()

Methods in org.apache.tika.parser.external2 with parameters of type Parser

Modifier and Type	Method	Description
void	ExternalParser.setOutputParser(Parser parser)	This parser is called on the output of the process.

Uses of Parser in org.apache.tika.parser.multiple

Classes in org.apache.tika.parser.multiple that implement Parser

Modifier and Type	Class	Description
class	AbstractMultipleParser	Abstract base class for parser wrappers which may / will process a given stream multiple times, merging the results of the various parsers used.
class	FallbackParser	Tries multiple parsers in turn, until one succeeds.
class	SupplementingParser	Runs the input stream through all available parsers, merging the metadata from them based on the AbstractMultipleParser.MetadataPolicy chosen.

Methods in org.apache.tika.parser.multiple that return types with arguments of type Parser

Modifier and Type	Method	Description
List<Parser>	AbstractMultipleParser.getAllParsers()

Methods in org.apache.tika.parser.multiple with parameters of type Parser

Modifier and Type	Method	Description
protected abstract boolean	AbstractMultipleParser.parserCompleted(Parser parser, Metadata metadata, ContentHandler handler, ParseContext context, Exception exception)	Used to notify implementations that a Parser has Finished or Failed, and to allow them to decide to continue or abort further parsing
protected boolean	FallbackParser.parserCompleted(Parser parser, Metadata metadata, ContentHandler handler, ParseContext context, Exception exception)
protected boolean	SupplementingParser.parserCompleted(Parser parser, Metadata metadata, ContentHandler handler, ParseContext context, Exception exception)
protected void	AbstractMultipleParser.parserPrepare(Parser parser, Metadata metadata, ParseContext context)	Used to allow implementations to prepare or change things before parsing occurs

Constructors in org.apache.tika.parser.multiple with parameters of type Parser

Constructor	Description
AbstractMultipleParser(MediaTypeRegistry registry, AbstractMultipleParser.MetadataPolicy policy, Parser... parsers)
FallbackParser(MediaTypeRegistry registry, AbstractMultipleParser.MetadataPolicy policy, Parser... parsers)
SupplementingParser(MediaTypeRegistry registry, AbstractMultipleParser.MetadataPolicy policy, Parser... parsers)

Constructor parameters in org.apache.tika.parser.multiple with type arguments of type Parser

Constructor	Description
AbstractMultipleParser(MediaTypeRegistry registry, Collection<? extends Parser> parsers, Map<String,Param> params)
AbstractMultipleParser(MediaTypeRegistry registry, AbstractMultipleParser.MetadataPolicy policy, Collection<? extends Parser> parsers)
FallbackParser(MediaTypeRegistry registry, Collection<? extends Parser> parsers, Map<String,Param> params)
FallbackParser(MediaTypeRegistry registry, AbstractMultipleParser.MetadataPolicy policy, Collection<? extends Parser> parsers)
SupplementingParser(MediaTypeRegistry registry, Collection<? extends Parser> parsers, Map<String,Param> params)
SupplementingParser(MediaTypeRegistry registry, AbstractMultipleParser.MetadataPolicy policy, Collection<? extends Parser> parsers)

Uses of Parser in org.apache.tika.utils

Methods in org.apache.tika.utils with parameters of type Parser

Modifier and Type	Method	Description
static String	ParserUtils.getParserClassname(Parser parser)	Identifies the real class name of the Parser, unwrapping any ParserDecorator decorations on top of it.
static void	ParserUtils.recordParserDetails(Parser parser, Metadata metadata)	Records details of the Parser used to the Metadata, typically wanted where multiple parsers could be picked between or used.
static void	ParserUtils.recordParserFailure(Parser parser, Throwable failure, Metadata metadata)	Records details of a Parser's failure to the Metadata, so you can check what went wrong even if the Exception wasn't immediately thrown (eg when several different Parsers are used)