public class TextOptions extends Object
Provides options for retrieving document text from an index.
Learn more
Constructor and Description |
---|
TextOptions()
Initializes a new instance of the
TextOptions class. |
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.
|
MetadataIndexingOptions |
getMetadataIndexingOptions()
Gets the options for indexing metadata fields.
|
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.
|
public TextOptions()
Initializes a new instance of the TextOptions
class.
public final 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.
public final 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.
value
- The custom text extractor that was used for indexing.public final 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.
public final 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.
value
- The additional document fields that was used for indexing.public final Cancellation getCancellation()
Gets the cancellation object.
The default value is null
.
public final void setCancellation(Cancellation value)
Sets the cancellation object.
The default value is null
.
value
- The cancellation object.public final MetadataIndexingOptions getMetadataIndexingOptions()
Gets the options for indexing metadata fields.