IndexingOptions

Inheritance: java.lang.Object

public class IndexingOptions

Provides options for indexing operation.

Learn more

Constructors

Constructor Description
IndexingOptions() Initializes a new instance of the IndexingOptions class.
IndexingOptions(Object data) Initializes a new instance of the IndexingOptions class.

Methods

Method Description
getThreads() Gets the number of threads used for indexing.
setThreads(int value) Sets the number of threads used for indexing.
isAsync() Gets the flag of asynchronous performing the operation.
setAsync(boolean value) Sets the flag of asynchronous performing the operation.
getCancellation() Gets the operation cancellation object.
setCancellation(Cancellation value) Sets the operation cancellation object.
getAutoDetectEncoding() Gets a value indicating whether to detect encoding automatically or not.
setAutoDetectEncoding(boolean value) Sets a value indicating whether to detect encoding automatically or not.
getEncoding() Gets the encoding used to extract text from text documents.
setEncoding(String value) Sets the encoding used to extract text from text documents.
getUseRawTextExtraction() Gets a value indicating whether the raw mode is used for text extraction if possible.
setUseRawTextExtraction(boolean value) Sets a value indicating whether the raw mode is used for text extraction if possible.
getMetadataIndexingOptions() Gets the options for indexing metadata fields.
getOcrIndexingOptions() Gets the options for OCR processing and indexing recognized text.
getImageIndexingOptions() Gets the image indexing options for reverse image search.
getCore()

IndexingOptions()

public IndexingOptions()

Initializes a new instance of the IndexingOptions class.

IndexingOptions(Object data)

public IndexingOptions(Object data)

Initializes a new instance of the IndexingOptions class.

Parameters:

Parameter Type Description
data java.lang.Object The serialized data.

getThreads()

public int getThreads()

Gets the number of threads used for indexing. The default value is 1 .

Returns: int - The number of threads used for indexing.

setThreads(int value)

public void setThreads(int value)

Sets the number of threads used for indexing. The default value is 1 .

Parameters:

Parameter Type Description
value int The number of threads used for indexing.

isAsync()

public boolean isAsync()

Gets the flag of asynchronous performing the operation. The default value is false .

Returns: boolean - The flag of asynchronous performing the operation.

setAsync(boolean value)

public void setAsync(boolean value)

Sets the flag of asynchronous performing the operation. The default value is false .

Parameters:

Parameter Type Description
value boolean The flag of asynchronous performing the operation.

getCancellation()

public Cancellation getCancellation()

Gets the operation cancellation object. The default value is null .

Returns: Cancellation - The operation cancellation object.

setCancellation(Cancellation value)

public void setCancellation(Cancellation value)

Sets the operation cancellation object. The default value is null .

Parameters:

Parameter Type Description
value Cancellation The operation cancellation object.

getAutoDetectEncoding()

public boolean getAutoDetectEncoding()

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

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

setAutoDetectEncoding(boolean value)

public void setAutoDetectEncoding(boolean value)

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

Parameters:

Parameter Type Description
value boolean A value indicating whether to detect encoding automatically or not.

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: java.lang.String - The encoding used to extract text from text documents.

setEncoding(String value)

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:

Parameter Type Description
value java.lang.String The encoding used to extract text from text documents.

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: boolean - A value indicating whether the raw mode is used for text extraction if possible.

setUseRawTextExtraction(boolean value)

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:

Parameter Type Description
value boolean A value indicating whether the raw mode is used for text extraction if possible.

getMetadataIndexingOptions()

public MetadataIndexingOptions getMetadataIndexingOptions()

Gets the options for indexing metadata fields.

Returns: MetadataIndexingOptions - The options for indexing metadata fields.

getOcrIndexingOptions()

public OcrIndexingOptions getOcrIndexingOptions()

Gets the options for OCR processing and indexing recognized text.

Returns: OcrIndexingOptions - The options for OCR processing and indexing recognized text.

getImageIndexingOptions()

public ImageIndexingOptions getImageIndexingOptions()

Gets the image indexing options for reverse image search.

Returns: ImageIndexingOptions - The image indexing options for reverse image search.

getCore()

public Object getCore()

Returns: java.lang.Object