com.groupdocs.search.options

Class UpdateOptions

java.lang.Object

com.groupdocs.search.options.UpdateOptions

public class UpdateOptions
extends Object

Provides options for update operation.

Learn more

• Update index
• Delete indexed paths

Constructor Summary

Constructors

Modifier	Constructor and Description
	UpdateOptions() Initializes a new instance of the UpdateOptions class.
	UpdateOptions(Object data) Initializes a new instance of the UpdateOptions class.
protected	UpdateOptions(Object state1, Object state2) Initializes a new instance of the UpdateOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	getAutoDetectEncoding() Gets a value indicating whether to detect encoding automatically or not.
Cancellation	getCancellation() Gets the operation cancellation object.
Object	getCore()
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.
int	getThreads() Gets the number of threads used for indexing.
boolean	getUseRawTextExtraction() Gets a value indicating whether the raw mode is used for text extraction if possible.
boolean	isAsync() Gets the flag of asynchronous performing the operation.
void	setAsync(boolean value) Sets the flag of asynchronous performing the operation.
void	setAutoDetectEncoding(boolean value) Sets a value indicating whether to detect encoding automatically or not.
void	setCancellation(Cancellation value) Sets the operation cancellation object.
void	setEncoding(String value) Sets the encoding used to extract text from text documents.
void	setThreads(int value) Sets the number of threads used for indexing.
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

UpdateOptions

public UpdateOptions()

Initializes a new instance of the UpdateOptions class.

UpdateOptions

public UpdateOptions(Object data)

Initializes a new instance of the UpdateOptions class.

Parameters:

data - The serialized data.

UpdateOptions

protected UpdateOptions(Object state1,
                        Object state2)

Initializes a new instance of the UpdateOptions 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.

getCancellation

public Cancellation getCancellation()

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

Returns:

The operation cancellation object.

getCore

public Object getCore()

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.

getThreads

public int getThreads()

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

Returns:

The number of threads used for indexing.

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.

isAsync

public boolean isAsync()

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

Returns:

The flag of asynchronous performing the operation.

setAsync

public void setAsync(boolean value)

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

Parameters:

value - The flag of asynchronous performing the operation.

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.

setCancellation

public void setCancellation(Cancellation value)

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

Parameters:

value - The operation cancellation object.

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.

setThreads

public void setThreads(int value)

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

Parameters:

value - The number of threads used for indexing.

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.