OcrIndexingOptions

Inheritance: java.lang.Object

public abstract class OcrIndexingOptions

Provides options for OCR processing and indexing recognized text.

Constructors

Constructor	Description
OcrIndexingOptions()

Methods

Method	Description
getEnabledForSeparateImages()	Gets a value indicating whether to recognize text in separate image files.
setEnabledForSeparateImages(boolean value)	Sets a value indicating whether to recognize text in separate image files.
getEnabledForContainerItemImages()	Gets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive).
setEnabledForContainerItemImages(boolean value)	Sets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive).
getEnabledForEmbeddedImages()	Gets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document).
setEnabledForEmbeddedImages(boolean value)	Sets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document).
getOcrConnector()	Gets an OCR connector that is used for OCR processing.
setOcrConnector(IOcrConnector value)	Sets an OCR connector that is used for OCR processing.

OcrIndexingOptions()

public OcrIndexingOptions()

getEnabledForSeparateImages()

public abstract boolean getEnabledForSeparateImages()

Gets a value indicating whether to recognize text in separate image files. The default value is false .

Returns: boolean - A value indicating whether to recognize text in separate image files.

setEnabledForSeparateImages(boolean value)

public abstract void setEnabledForSeparateImages(boolean value)

Sets a value indicating whether to recognize text in separate image files. The default value is false .

Parameters:

Parameter	Type	Description
value	boolean	A value indicating whether to recognize text in separate image files.

getEnabledForContainerItemImages()

public abstract boolean getEnabledForContainerItemImages()

Gets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive). The default value is false .

Returns: boolean - A value indicating whether to recognize text in images that are items in a container.

setEnabledForContainerItemImages(boolean value)

public abstract void setEnabledForContainerItemImages(boolean value)

Sets a value indicating whether to recognize text in images that are items in a container (for example, images in a ZIP archive). The default value is false .

Parameters:

Parameter	Type	Description
value	boolean	A value indicating whether to recognize text in images that are items in a container.

getEnabledForEmbeddedImages()

public abstract boolean getEnabledForEmbeddedImages()

Gets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document). The default value is false .

Returns: boolean - A value indicating whether to recognize text in embedded images.

setEnabledForEmbeddedImages(boolean value)

public abstract void setEnabledForEmbeddedImages(boolean value)

Sets a value indicating whether to recognize text in embedded images (for example, images in a DOCX document). The default value is false .

Parameters:

Parameter	Type	Description
value	boolean	A value indicating whether to recognize text in embedded images.

getOcrConnector()

public abstract IOcrConnector getOcrConnector()

Gets an OCR connector that is used for OCR processing. The default value is null , which means no OCR is used.

Returns: IOcrConnector - An OCR connector that is used for OCR processing.

setOcrConnector(IOcrConnector value)

public abstract void setOcrConnector(IOcrConnector value)

Sets an OCR connector that is used for OCR processing. The default value is null , which means no OCR is used.

Parameters:

Parameter	Type	Description
value	IOcrConnector	An OCR connector that is used for OCR processing.