com.arakelian.elastic.model

Enum Field.IndexOptions

java.lang.Object

java.lang.Enum<Field.IndexOptions>

com.arakelian.elastic.model.Field.IndexOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Field.IndexOptions>

Enclosing class:

Field

public static enum Field.IndexOptions
extends java.lang.Enum<Field.IndexOptions>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCS Only the doc number is indexed.
FREQS Doc number and term frequencies are indexed.
OFFSETS Doc number, term frequencies, positions, and start and end character offsets (which map the term back to the original string) are indexed.
POSITIONS Doc number, term frequencies, and term positions (or order) are indexed.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static Field.IndexOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Field.IndexOptions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOCS

public static final Field.IndexOptions DOCS

Only the doc number is indexed. Can answer the question Does this term exist in this field?

FREQS

public static final Field.IndexOptions FREQS

Doc number and term frequencies are indexed. Term frequencies are used to score repeated terms higher than single terms.

POSITIONS

public static final Field.IndexOptions POSITIONS

Doc number, term frequencies, and term positions (or order) are indexed. Positions can be used for proximity or phrase queries.

OFFSETS

public static final Field.IndexOptions OFFSETS

Doc number, term frequencies, positions, and start and end character offsets (which map the term back to the original string) are indexed. Offsets are used by the Highlighter.Type.UNIFIED highlighter to speed up highlighting.

Method Detail

values

public static Field.IndexOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Field.IndexOptions c : Field.IndexOptions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Field.IndexOptions valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Field.IndexOptions>