org.apache.tika.parser.ocr

Class TesseractOCRConfig

java.lang.Object

org.apache.tika.parser.ocr.TesseractOCRConfig

All Implemented Interfaces:

Serializable

public class TesseractOCRConfig
extends Object
implements Serializable

Configuration for TesseractOCRParser. This allows to enable TesseractOCRParser and set its parameters:

TesseractOCRConfig config = new TesseractOCRConfig();
config.setTesseractPath(tesseractFolder);
parseContext.set(TesseractOCRConfig.class, config);

Parameters can also be set by either editing the existing TesseractOCRConfig.properties file in, tika-parser/src/main/resources/org/apache/tika/parser/ocr, or overriding it by creating your own and placing it in the package org/apache/tika/parser/ocr on the classpath.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TesseractOCRConfig() Default contructor.
TesseractOCRConfig(InputStream is) Loads properties from InputStream and then tries to close InputStream.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLanguage()
int	getMaxFileSizeToOcr()
int	getMinFileSizeToOcr()
String	getPageSegMode()
String	getTessdataPath()
String	getTesseractPath()
int	getTimeout()
void	setLanguage(String language) Set tesseract language dictionary to be used.
void	setMaxFileSizeToOcr(int maxFileSizeToOcr) Set maximum file size to submit file to ocr.
void	setMinFileSizeToOcr(int minFileSizeToOcr) Set minimum file size to submit file to ocr.
void	setPageSegMode(String pageSegMode) Set tesseract page segmentation mode.
void	setTessdataPath(String tessdataPath) Set the path to the 'tessdata' folder, which contains language files and config files.
void	setTesseractPath(String tesseractPath) Set the path to the Tesseract executable, needed if it is not on system path.
void	setTimeout(int timeout) Set maximum time (seconds) to wait for the ocring process to terminate.

Methods inherited from class java.lang.Object

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

Constructor Detail

TesseractOCRConfig

public TesseractOCRConfig()

Default contructor.

TesseractOCRConfig

public TesseractOCRConfig(InputStream is)

Loads properties from InputStream and then tries to close InputStream. If there is an IOException, this silently swallows the exception and goes back to the default.

Parameters:

is -

Method Detail

getTesseractPath

public String getTesseractPath()

See Also:

setTesseractPath(String tesseractPath)

setTesseractPath

public void setTesseractPath(String tesseractPath)

Set the path to the Tesseract executable, needed if it is not on system path.

Note that if you set this value, it is highly recommended that you also set the path to the 'tessdata' folder using setTessdataPath(java.lang.String).

getTessdataPath

public String getTessdataPath()

See Also:

setTessdataPath(String tessdataPath)

setTessdataPath

public void setTessdataPath(String tessdataPath)

Set the path to the 'tessdata' folder, which contains language files and config files. In some cases (such as on Windows), this folder is found in the Tesseract installation, but in other cases (such as when Tesseract is built from source), it may be located elsewhere.

getLanguage

public String getLanguage()

See Also:

setLanguage(String language)

setLanguage

public void setLanguage(String language)

Set tesseract language dictionary to be used. Default is "eng". Multiple languages may be specified, separated by plus characters.

getPageSegMode

public String getPageSegMode()

See Also:

setPageSegMode(String pageSegMode)

setPageSegMode

public void setPageSegMode(String pageSegMode)

Set tesseract page segmentation mode. Default is 1 = Automatic page segmentation with OSD (Orientation and Script Detection)

getMinFileSizeToOcr

public int getMinFileSizeToOcr()

See Also:

setMinFileSizeToOcr(int minFileSizeToOcr)

setMinFileSizeToOcr

public void setMinFileSizeToOcr(int minFileSizeToOcr)

Set minimum file size to submit file to ocr. Default is 0.

getMaxFileSizeToOcr

public int getMaxFileSizeToOcr()

See Also:

setMaxFileSizeToOcr(int maxFileSizeToOcr)

setMaxFileSizeToOcr

public void setMaxFileSizeToOcr(int maxFileSizeToOcr)

Set maximum file size to submit file to ocr. Default is Integer.MAX_VALUE.

setTimeout

public void setTimeout(int timeout)

Set maximum time (seconds) to wait for the ocring process to terminate. Default value is 120s.

getTimeout

public int getTimeout()

See Also:

setTimeout(int timeout)