- All Implemented Interfaces:
Serializable
,Comparable<IndexOptions>
,Constable
Controls how much information is stored in the postings lists.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionOnly documents are indexed: term frequencies and positions are omitted.Only documents and term frequencies are indexed: positions are omitted.Indexes documents, frequencies and positions.Indexes documents, frequencies, positions and offsets.Not indexed -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic IndexOptions
Returns the enum constant of this class with the specified name.static IndexOptions[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
Not indexed -
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
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
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
Indexes documents, frequencies, positions and offsets. Character offsets are encoded alongside the positions.
-
-
Constructor Details
-
IndexOptions
private IndexOptions()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-