Package org.apache.tika.parser.pdf

Class OcrConfig

java.lang.Object

org.apache.tika.parser.pdf.OcrConfig

All Implemented Interfaces:

Serializable

public class OcrConfig
extends Object
implements Serializable

Configuration for OCR processing in PDF parsing. Groups all OCR-related settings together.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OcrConfig.ImageFormat
static enum	OcrConfig.ImageType
static enum	OcrConfig.RenderingStrategy
static enum	OcrConfig.Strategy
static class	OcrConfig.StrategyAuto	Configuration for AUTO strategy behavior.

Constructor Summary

Constructors

Constructor	Description
OcrConfig()

Method Summary

Modifier and Type	Method	Description
int	getDpi()
OcrConfig.ImageFormat	getImageFormat()
float	getImageQuality()
OcrConfig.ImageType	getImageType()
long	getMaxImagePixels()
int	getMaxPagesToOcr()
OcrConfig.RenderingStrategy	getRenderingStrategy()
OcrConfig.Strategy	getStrategy()
OcrConfig.StrategyAuto	getStrategyAuto()
void	setDpi(int dpi)
void	setImageFormat(OcrConfig.ImageFormat imageFormat)
void	setImageQuality(float imageQuality)
void	setImageType(OcrConfig.ImageType imageType)
void	setMaxImagePixels(long maxImagePixels)	Set the maximum total pixels (width × height) for a rendered page image.
void	setMaxPagesToOcr(int maxPagesToOcr)	Set the maximum number of pages to OCR per document.
void	setRenderingStrategy(OcrConfig.RenderingStrategy renderingStrategy)
void	setStrategy(OcrConfig.Strategy strategy)
void	setStrategyAuto(OcrConfig.StrategyAuto strategyAuto)

Methods inherited from class java.lang.Object

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

Constructor Details

OcrConfig

public OcrConfig()

Method Details

getStrategy

public OcrConfig.Strategy getStrategy()

setStrategy

public void setStrategy(OcrConfig.Strategy strategy)

getStrategyAuto

public OcrConfig.StrategyAuto getStrategyAuto()

setStrategyAuto

public void setStrategyAuto(OcrConfig.StrategyAuto strategyAuto)

getRenderingStrategy

public OcrConfig.RenderingStrategy getRenderingStrategy()

setRenderingStrategy

public void setRenderingStrategy(OcrConfig.RenderingStrategy renderingStrategy)

getDpi

public int getDpi()

setDpi

public void setDpi(int dpi)

getImageType

public OcrConfig.ImageType getImageType()

setImageType

public void setImageType(OcrConfig.ImageType imageType)

getImageFormat

public OcrConfig.ImageFormat getImageFormat()

setImageFormat

public void setImageFormat(OcrConfig.ImageFormat imageFormat)

getImageQuality

public float getImageQuality()

setImageQuality

public void setImageQuality(float imageQuality)

getMaxImagePixels

public long getMaxImagePixels()

setMaxImagePixels

public void setMaxImagePixels(long maxImagePixels)

Set the maximum total pixels (width × height) for a rendered page image. Pages exceeding this limit are skipped for OCR. Default is 100,000,000. Set to -1 for no limit (not recommended).

getMaxPagesToOcr

public int getMaxPagesToOcr()

setMaxPagesToOcr

public void setMaxPagesToOcr(int maxPagesToOcr)

Set the maximum number of pages to OCR per document. Default is -1 (no limit). Must be -1 or at least 1.