sirius.db.es.annotations

Enum Analyzed.IndexOption

java.lang.Object

java.lang.Enum<Analyzed.IndexOption>

sirius.db.es.annotations.Analyzed.IndexOption

All Implemented Interfaces:

Serializable, Comparable<Analyzed.IndexOption>

Enclosing class:

Analyzed

public static enum Analyzed.IndexOption
extends Enum<Analyzed.IndexOption>

Spexifies index options passed to elasticsearch.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT This will instruct elasticsearch to use the default settings.
DOCS This will instruct elasticsearch to only store the doc id for a token.
FREQS This will instruct elasticsearch to store the doc id and the term frequency for a token.
OFFSETS This will instruct elasticsearch to store the doc id, the term frequency, the position and the start and end character offsets for a token.
POSITIONS This will instruct elasticsearch to store the doc id, the term frequency and the position for a token.

Method Summary

Modifier and Type	Method and Description
static Analyzed.IndexOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static Analyzed.IndexOption[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final Analyzed.IndexOption DEFAULT

This will instruct elasticsearch to use the default settings.

DOCS

public static final Analyzed.IndexOption DOCS

This will instruct elasticsearch to only store the doc id for a token.

FREQS

public static final Analyzed.IndexOption FREQS

This will instruct elasticsearch to store the doc id and the term frequency for a token.

POSITIONS

public static final Analyzed.IndexOption POSITIONS

This will instruct elasticsearch to store the doc id, the term frequency and the position for a token.

OFFSETS

public static final Analyzed.IndexOption OFFSETS

This will instruct elasticsearch to store the doc id, the term frequency, the position and the start and end character offsets for a token.

Method Detail

values

public static Analyzed.IndexOption[] 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 (Analyzed.IndexOption c : Analyzed.IndexOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static Analyzed.IndexOption 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