com.groupdocs.search.options

Interface ITextOptions

All Known Subinterfaces:

IHighlightOptions

All Known Implementing Classes:

HighlightOptions, TextOptions

public interface ITextOptions

Defines interface of options for retrieving document text from an index.

Learn more

• Getting indexed documents
• Highlighting search results

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.
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.

Method Detail

getAdditionalFields

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.

Returns:

The additional document fields that was used for indexing.

getCancellation

Cancellation getCancellation()

Gets the cancellation object. The default value is null.

Returns:

The cancellation object.

getCustomExtractor

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.

Returns:

The custom text extractor that was used for indexing.

getGenerateHead

boolean getGenerateHead()

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

Returns:

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

getImageIndexingOptions

ImageIndexingOptions getImageIndexingOptions()

Gets the image indexing options for reverse image search.

Returns:

The image indexing options for reverse image search.

getMetadataIndexingOptions

MetadataIndexingOptions getMetadataIndexingOptions()

Gets the options for indexing metadata fields.

Returns:

The options for indexing metadata fields.

getOcrIndexingOptions

OcrIndexingOptions getOcrIndexingOptions()

Gets the options for OCR processing and indexing recognized text.

Returns:

The options for OCR processing and indexing recognized text.

getUseRawTextExtraction

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.

setAdditionalFields

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.

Parameters:

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

setCancellation

void setCancellation(Cancellation value)

Sets the cancellation object. The default value is null.

Parameters:

value - The cancellation object.

setCustomExtractor

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.

Parameters:

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

setGenerateHead

void setGenerateHead(boolean value)

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

Parameters:

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

setUseRawTextExtraction

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.