TextOptions Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.search.options.ITextOptions
public class TextOptions implements ITextOptions
Provides options for retrieving document text from an index.
Learn more
| Constructor | Description |
|---|---|
| TextOptions() | Initializes a new instance of the TextOptions class. |
| TextOptions(Object data) | Initializes a new instance of the TextOptions class. |
| Method | Description |
|---|---|
| getCustomExtractor() | Gets the custom text extractor that was used for indexing. |
| setCustomExtractor(IFieldExtractor value) | Sets the custom text extractor that was used for indexing. |
| getAdditionalFields() | Gets the additional document fields that was used for indexing. |
| setAdditionalFields(DocumentField[] value) | Sets the additional document fields that was used for indexing. |
| getCancellation() | Gets the cancellation object. |
| setCancellation(Cancellation value) | Sets the cancellation object. |
| getGenerateHead() | Gets a value indicating whether the Head tag is generated in the output HTML. |
| setGenerateHead(boolean value) | Sets a value indicating whether the Head tag is generated in the output HTML. |
| 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() |
public TextOptions()
Initializes a new instance of the TextOptions class.
public TextOptions(Object data)
Initializes a new instance of the TextOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| data | java.lang.Object | The serialized data. |
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.
Returns: IFieldExtractor - The custom text extractor that was used for indexing.
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IFieldExtractor | The custom text extractor that was used for indexing. |
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.
Returns: com.groupdocs.search.common.DocumentField[] - The additional document fields that was used for indexing.
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DocumentField[] | The additional document fields that was used for indexing. |
public Cancellation getCancellation()
Gets the cancellation object. The default value is null .
Returns: Cancellation - The cancellation object.
public void setCancellation(Cancellation value)
Sets the cancellation object. The default value is null .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Cancellation | The cancellation object. |
public boolean getGenerateHead()
Gets a value indicating whether the Head tag is generated in the output HTML. The default value is true .
Returns: boolean - A value indicating whether the Head tag is generated in the output HTML.
public void setGenerateHead(boolean value)
Sets a value indicating whether the Head tag is generated in the output HTML. The default value is true .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating whether the Head tag is generated in the output HTML. |
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.
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. |
public MetadataIndexingOptions getMetadataIndexingOptions()
Gets the options for indexing metadata fields.
Returns: MetadataIndexingOptions - The options for indexing metadata fields.
public OcrIndexingOptions getOcrIndexingOptions()
Gets the options for OCR processing and indexing recognized text.
Returns: OcrIndexingOptions - The options for OCR processing and indexing recognized text.
public ImageIndexingOptions getImageIndexingOptions()
Gets the image indexing options for reverse image search.
Returns: ImageIndexingOptions - The image indexing options for reverse image search.
public Object getCore()
Returns: java.lang.Object
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.