com.groupdocs.search.options

Class TextOptions

  • Direct Known Subclasses:
    HighlightOptions


    public class TextOptions
    extends Object

    Provides options for retrieving document text from an index.

    • Constructor Detail

      • TextOptions

        public TextOptions()

        Initializes a new instance of the TextOptions class.

    • Method Detail

      • getCustomExtractor

        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.

        Returns:
        The custom text extractor that was used for indexing.
      • setCustomExtractor

        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.

        Parameters:
        value - The custom text extractor that was used for indexing.
      • getAdditionalFields

        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.

        Returns:
        The additional document fields that was used for indexing.
      • setAdditionalFields

        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.

        Parameters:
        value - The additional document fields that was used for indexing.
      • getCancellation

        public final Cancellation getCancellation()

        Gets the cancellation object. The default value is null.

        Returns:
        The cancellation object.
      • setCancellation

        public final void setCancellation(Cancellation value)

        Sets the cancellation object. The default value is null.

        Parameters:
        value - The cancellation object.
      • getMetadataIndexingOptions

        public final MetadataIndexingOptions getMetadataIndexingOptions()

        Gets the options for indexing metadata fields.

        Returns:
        The options for indexing metadata fields.