com.groupdocs.search.options

Class ExtractionOptions

java.lang.Object

com.groupdocs.search.options.ExtractionOptions

public class ExtractionOptions
extends Object

Provides options for extracting data from documents.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExtractionOptions() Initializes a new instance of the ExtractionOptions class.
	ExtractionOptions(IndexingOptions options, IFieldExtractor customExtractor, IOcrConnector ocrConnector) Initializes a new instance of the ExtractionOptions class.
	ExtractionOptions(Object data) Initializes a new instance of the ExtractionOptions class.
protected	ExtractionOptions(Object state1, Object state2) Initializes a new instance of the ExtractionOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	getAutoDetectEncoding() Gets a value indicating whether to detect encoding automatically or not.
Object	getCore()
IFieldExtractor	getCustomExtractor() Gets the custom text extractor.
String	getEncoding() Gets the encoding used to extract text from text documents.
ImageIndexingOptions	getImageIndexingOptions() Gets the image indexing options for reverse image search.
MetadataIndexingOptions	getMetadataIndexingOptions() Gets the options for indexing metadata fields.
OcrIndexingOptions	getOcrIndexingOptions() Gets the options for OCR processing and indexing recognized text.
boolean	getUseRawTextExtraction() Gets a value indicating whether the raw mode is used for text extraction if possible.
void	setAutoDetectEncoding(boolean value) Sets a value indicating whether to detect encoding automatically or not.
void	setCustomExtractor(IFieldExtractor value) Sets or sets the custom text extractor.
void	setEncoding(String value) Sets the encoding used to extract text from text documents.
void	setUseRawTextExtraction(boolean value) Sets a value indicating whether the raw mode is used for text extraction if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractionOptions

public ExtractionOptions()

Initializes a new instance of the ExtractionOptions class.

ExtractionOptions

public ExtractionOptions(IndexingOptions options,
                         IFieldExtractor customExtractor,
                         IOcrConnector ocrConnector)

Initializes a new instance of the ExtractionOptions class.

Parameters:

options - The options.

customExtractor - The custom extractor.

ocrConnector - The ocr connector.

ExtractionOptions

public ExtractionOptions(Object data)

Initializes a new instance of the ExtractionOptions class.

Parameters:

data - The serialized data.

ExtractionOptions

protected ExtractionOptions(Object state1,
                            Object state2)

Initializes a new instance of the ExtractionOptions class.

Parameters:

state1 - The state 1.

state2 - The state 2.

Method Detail

getAutoDetectEncoding

public boolean getAutoDetectEncoding()

Gets a value indicating whether to detect encoding automatically or not. The default value is false.

Returns:

A value indicating whether to detect encoding automatically or not.

getCore

public Object getCore()

getCustomExtractor

public IFieldExtractor getCustomExtractor()

Gets the custom text extractor. The default value is null.

Returns:

The custom text extractor.

getEncoding

public String getEncoding()

Gets the encoding used to extract text from text documents. The default value is null, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is true then this value is used as the default encoding.

Returns:

The encoding used to extract text from text documents.

getImageIndexingOptions

public ImageIndexingOptions getImageIndexingOptions()

Gets the image indexing options for reverse image search.

Returns:

The image indexing options for reverse image search.

getMetadataIndexingOptions

public MetadataIndexingOptions getMetadataIndexingOptions()

Gets the options for indexing metadata fields.

Returns:

The options for indexing metadata fields.

getOcrIndexingOptions

public OcrIndexingOptions getOcrIndexingOptions()

Gets the options for OCR processing and indexing recognized text.

Returns:

The options for OCR processing and indexing recognized text.

getUseRawTextExtraction

public boolean getUseRawTextExtraction()

Gets a value indicating whether the raw mode is used for text extraction if possible. The default value is true. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

Returns:

A value indicating whether the raw mode is used for text extraction if possible.

setAutoDetectEncoding

public void setAutoDetectEncoding(boolean value)

Sets a value indicating whether to detect encoding automatically or not. The default value is false.

Parameters:

value - A value indicating whether to detect encoding automatically or not.

setCustomExtractor

public void setCustomExtractor(IFieldExtractor value)

Sets or sets the custom text extractor. The default value is null.

Parameters:

value - The custom text extractor.

setEncoding

public void setEncoding(String value)

Sets the encoding used to extract text from text documents. The default value is null, which means that the default encoding UTF-8 is used. If AutoDetectEncoding is true then this value is used as the default encoding.

Parameters:

value - The encoding used to extract text from text documents.

setUseRawTextExtraction

public void setUseRawTextExtraction(boolean value)

Sets a value indicating whether the raw mode is used for text extraction if possible. The default value is true. The raw mode can significantly increase the indexing speed, but normal mode improves the formatting of the extracted text.

Parameters:

value - A value indicating whether the raw mode is used for text extraction if possible.