Package org.apache.tika.parser.ocr

Class TesseractOCRParser

java.lang.Object

org.apache.tika.parser.AbstractExternalProcessParser

org.apache.tika.parser.ocr.TesseractOCRParser

All Implemented Interfaces:

Serializable, Initializable, SelfConfiguring, Parser

public class TesseractOCRParser
extends AbstractExternalProcessParser
implements Initializable

TesseractOCRParser powered by tesseract-ocr engine. To enable this parser, create a TesseractOCRConfig object and pass it through a ParseContext. Tesseract-ocr must be installed and on system path or the path to its root folder must be provided:

TesseractOCRConfig config = new TesseractOCRConfig();
//Needed if tesseract is not on system path
config.setTesseractPath(tesseractFolder);
parseContext.set(TesseractOCRConfig.class, config);

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Property	IMAGE_MAGICK
static final Property	IMAGE_ROTATION
static final Property	PSM0_ORIENTATION
static final Property	PSM0_ORIENTATION_CONFIDENCE
static final Property	PSM0_PAGE_NUMBER
static final Property	PSM0_ROTATE
static final Property	PSM0_SCRIPT
static final Property	PSM0_SCRIPT_CONFIDENCE
static final String	TESS_META

Constructor Summary

Constructors

Constructor	Description
TesseractOCRParser()
TesseractOCRParser(JsonConfig jsonConfig)	Constructor for JSON configuration.
TesseractOCRParser(TesseractOCRConfig tesseractOCRConfig)

Method Summary

Modifier and Type	Method	Description
void	checkInitialization()
TesseractOCRConfig	getDefaultConfig()
static String	getImageMagickProg()
Set<String>	getLangs()
List<String>	getOtherTesseractSettings()
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
static String	getTesseractProg()
boolean	hasTesseract()
protected boolean	hasWarned()
void	initialize()	Called after all properties have been set to allow for validation and initialization that depends on multiple properties.
void	parse(Image image, ContentHandler handler, Metadata metadata, ParseContext context)
void	parse(TikaInputStream tis, ContentHandler handler, Metadata metadata, ParseContext parseContext)	Parses a document stream into a sequence of XHTML SAX events.
void	setOtherTesseractSettings(List<String> settings)
protected void	warn()

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

register, release

Methods inherited from class java.lang.Object

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

Field Details

TESS_META

public static final String TESS_META

See Also:

• Constant Field Values

IMAGE_ROTATION

public static final Property IMAGE_ROTATION

IMAGE_MAGICK

public static final Property IMAGE_MAGICK

PSM0_PAGE_NUMBER

public static final Property PSM0_PAGE_NUMBER

PSM0_ORIENTATION

public static final Property PSM0_ORIENTATION

PSM0_ROTATE

public static final Property PSM0_ROTATE

PSM0_ORIENTATION_CONFIDENCE

public static final Property PSM0_ORIENTATION_CONFIDENCE

PSM0_SCRIPT

public static final Property PSM0_SCRIPT

PSM0_SCRIPT_CONFIDENCE

public static final Property PSM0_SCRIPT_CONFIDENCE

Constructor Details

TesseractOCRParser

public TesseractOCRParser()
                   throws TikaConfigException

Throws:

TikaConfigException

TesseractOCRParser

public TesseractOCRParser(TesseractOCRConfig tesseractOCRConfig)
                   throws TikaConfigException

Throws:

TikaConfigException

TesseractOCRParser

public TesseractOCRParser(JsonConfig jsonConfig)
                   throws TikaConfigException

Constructor for JSON configuration. Requires Jackson on the classpath.

Parameters:

jsonConfig - JSON configuration

Throws:

TikaConfigException

Method Details

getImageMagickProg

public static String getImageMagickProg()

getTesseractProg

public static String getTesseractProg()

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.

Specified by:

getSupportedTypes in interface Parser

Parameters:

context - parse context

Returns:

immutable set of media types

hasTesseract

public boolean hasTesseract()
                     throws TikaConfigException

Throws:

TikaConfigException

parse

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

Throws:

IOException

SAXException

TikaException

parse

public void parse(TikaInputStream tis,
 ContentHandler handler,
 Metadata metadata,
 ParseContext parseContext)
           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.

Specified by:

parse in interface Parser

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

parseContext - 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

initialize

public void initialize()
                throws TikaConfigException

Description copied from interface: Initializable

Called after all properties have been set to allow for validation and initialization that depends on multiple properties.

Specified by:

initialize in interface Initializable

Throws:

TikaConfigException - if there is a problem with the configuration

checkInitialization

public void checkInitialization()
                         throws TikaConfigException

Throws:

TikaConfigException

getLangs

public Set<String> getLangs()

hasWarned

protected boolean hasWarned()

warn

protected void warn()

setOtherTesseractSettings

public void setOtherTesseractSettings(List<String> settings)
                               throws TikaConfigException

Throws:

TikaConfigException

getOtherTesseractSettings

public List<String> getOtherTesseractSettings()

getDefaultConfig

public TesseractOCRConfig getDefaultConfig()