com.groupdocs.search.options

Class TextOptions

java.lang.Object

com.groupdocs.search.options.TextOptions

All Implemented Interfaces:

ITextOptions

Direct Known Subclasses:

HighlightOptions

public class TextOptions
extends Object
implements ITextOptions

Provides options for retrieving document text from an index.

Learn more

• Getting indexed documents
• Highlighting search results

Field Summary

Fields

Modifier and Type	Field and Description
protected ITextOptions	core

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DocumentField[]	getAdditionalFields() Gets the additional document fields that was used for indexing.
Cancellation	getCancellation() Gets the cancellation object.
Object	getCore()
IFieldExtractor	getCustomExtractor() Gets the custom text extractor that was used for indexing.
boolean	getGenerateHead() Gets a value indicating whether the Head tag is generated in the output HTML.
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	setAdditionalFields(DocumentField[] value) Sets the additional document fields that was used for indexing.
void	setCancellation(Cancellation value) Sets the cancellation object.
void	setCustomExtractor(IFieldExtractor value) Sets the custom text extractor that was used for indexing.
void	setGenerateHead(boolean value) Sets a value indicating whether the Head tag is generated in the output HTML.
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

Field Detail

core

protected final ITextOptions core

Constructor Detail

TextOptions

public TextOptions()

Initializes a new instance of the TextOptions class.

TextOptions

protected TextOptions(ITextOptions options)

Initializes a new instance of the TextOptions class.

Parameters:

options - The text options.

TextOptions

public TextOptions(Object data)

Initializes a new instance of the TextOptions class.

Parameters:

data - The serialized data.

TextOptions

protected TextOptions(Object state1,
                      Object state2)

Initializes a new instance of the TextOptions class.

Parameters:

state1 - The state 1.

state2 - The state 2.

Method Detail

getAdditionalFields

public DocumentField[] getAdditionalFields()

Gets the additional document fields that was used for indexing. The default value is null. Note that this value is used only if document text was not saved into the index.

Specified by:

getAdditionalFields in interface ITextOptions

Returns:

The additional document fields that was used for indexing.

getCancellation

public Cancellation getCancellation()

Gets the cancellation object. The default value is null.

Specified by:

getCancellation in interface ITextOptions

Returns:

The cancellation object.

getCore

public Object getCore()

getCustomExtractor

public IFieldExtractor getCustomExtractor()

Gets the custom text extractor that was used for indexing. The default value is null. Note that this value is used only if document text was not saved into the index.

Specified by:

getCustomExtractor in interface ITextOptions

Returns:

The custom text extractor that was used for indexing.

getGenerateHead

public boolean getGenerateHead()

Gets a value indicating whether the Head tag is generated in the output HTML. The default value is true.

Specified by:

getGenerateHead in interface ITextOptions

Returns:

A value indicating whether the Head tag is generated in the output HTML.

getImageIndexingOptions

public ImageIndexingOptions getImageIndexingOptions()

Gets the image indexing options for reverse image search.

Specified by:

getImageIndexingOptions in interface ITextOptions

Returns:

The image indexing options for reverse image search.

getMetadataIndexingOptions

public MetadataIndexingOptions getMetadataIndexingOptions()

Gets the options for indexing metadata fields.

Specified by:

getMetadataIndexingOptions in interface ITextOptions

Returns:

The options for indexing metadata fields.

getOcrIndexingOptions

public OcrIndexingOptions getOcrIndexingOptions()

Gets the options for OCR processing and indexing recognized text.

Specified by:

getOcrIndexingOptions in interface ITextOptions

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.

Specified by:

getUseRawTextExtraction in interface ITextOptions

Returns:

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

setAdditionalFields

public void setAdditionalFields(DocumentField[] value)

Sets the additional document fields that was used for indexing. The default value is null. Note that this value is used only if document text was not saved into the index.

Specified by:

setAdditionalFields in interface ITextOptions

Parameters:

value - The additional document fields that was used for indexing.

setCancellation

public void setCancellation(Cancellation value)

Sets the cancellation object. The default value is null.

Specified by:

setCancellation in interface ITextOptions

Parameters:

value - The cancellation object.

setCustomExtractor

public void setCustomExtractor(IFieldExtractor value)

Sets the custom text extractor that was used for indexing. The default value is null. Note that this value is used only if document text was not saved into the index.

Specified by:

setCustomExtractor in interface ITextOptions

Parameters:

value - The custom text extractor that was used for indexing.

setGenerateHead

public void setGenerateHead(boolean value)

Sets a value indicating whether the Head tag is generated in the output HTML. The default value is true.

Specified by:

setGenerateHead in interface ITextOptions

Parameters:

value - A value indicating whether the Head tag is generated in the output HTML.

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.

Specified by:

setUseRawTextExtraction in interface ITextOptions

Parameters:

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