Package org.apache.tika.parser.enricher

Class GatedEnricher

java.lang.Object

org.apache.tika.parser.ParserDecorator

org.apache.tika.parser.enricher.GatedEnricher

All Implemented Interfaces:

Serializable, SelfConfiguring, Parser

public class GatedEnricher
extends ParserDecorator

A text recognizer behind a chain of ImageChecks, in order. The first check to refuse keeps the image from the engine and records skipped:<reason>; a check that fails admits it. One decorator however many checks an entry lists.

Since:

Apache Tika 4.2

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tika.parser.ParserDecorator

ParserDecorator.MimeFilteringDecorator

Constructor Summary

Constructors

Constructor	Description
GatedEnricher(Parser parser, List<ImageCheck> checks)

Method Summary

Modifier and Type	Method	Description
List<ImageCheck>	getChecks()
String	getDecorationName()
void	parse(TikaInputStream tis, ContentHandler handler, Metadata metadata, ParseContext context)	Delegates the method call to the decorated parser.

Methods inherited from class org.apache.tika.parser.ParserDecorator

getSupportedTypes, getWrappedParser, withFallbacks, withMimeFilters, withoutTypes, withTypes

Methods inherited from class java.lang.Object

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

Constructor Details

GatedEnricher

public GatedEnricher(Parser parser,
 List<ImageCheck> checks)

Method Details

getChecks

public List<ImageCheck> getChecks()

parse

public void parse(TikaInputStream tis,
 ContentHandler handler,
 Metadata metadata,
 ParseContext context)
           throws IOException,
SAXException,
TikaException

Description copied from class: ParserDecorator

Delegates the method call to the decorated parser. Subclasses should override this method (and use super.parse() to invoke the decorated parser) to implement extra decoration.

Specified by:

parse in interface Parser

Overrides:

parse in class ParserDecorator

Parameters:

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

getDecorationName

public String getDecorationName()

Overrides:

getDecorationName in class ParserDecorator

Returns:

A name/description of the decoration, or null if none available