Package org.apache.lucene.index

Enum IndexOptions

java.lang.Object
java.lang.Enum<IndexOptions>
org.apache.lucene.index.IndexOptions
All Implemented Interfaces:
Serializable, Comparable<IndexOptions>
public enum IndexOptions extends Enum<IndexOptions>
Controls how much information is stored in the postings lists.
WARNING: This API is experimental and might change in incompatible ways in the next release.

  • Enum Constant Details

    • NONE

      public static final IndexOptions NONE
      Not indexed

    • DOCS

      public static final IndexOptions DOCS
      Only documents are indexed: term frequencies and positions are omitted. Phrase and other positional queries on the field will throw an exception, and scoring will behave as if any term in the document appears only once.

    • DOCS_AND_FREQS

      public static final IndexOptions DOCS_AND_FREQS
      Only documents and term frequencies are indexed: positions are omitted. This enables normal scoring, except Phrase and other positional queries will throw an exception.

    • DOCS_AND_FREQS_AND_POSITIONS

      public static final IndexOptions DOCS_AND_FREQS_AND_POSITIONS
      Indexes documents, frequencies and positions. This is a typical default for full-text search: full scoring is enabled and positional queries are supported.

    • DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS

      public static final IndexOptions DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS
      Indexes documents, frequencies, positions and offsets. Character offsets are encoded alongside the positions.

  • Method Details

    • values

      public static IndexOptions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static IndexOptions valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null