com.arakelian.elastic.model

Enum Field.TermVector

java.lang.Object

java.lang.Enum<Field.TermVector>

com.arakelian.elastic.model.Field.TermVector

All Implemented Interfaces:

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

Enclosing class:

Field

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO No term vectors are stored.
WITH_OFFSETS Terms and character offsets are stored.
WITH_POSITIONS Terms and positions are stored.
WITH_POSITIONS_OFFSETS Terms, positions, and character offsets are stored.
YES Just the terms in the field are stored.

Method Summary

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

NO

public static final Field.TermVector NO

No term vectors are stored. (default)

YES

public static final Field.TermVector YES

Just the terms in the field are stored.

WITH_POSITIONS

public static final Field.TermVector WITH_POSITIONS

Terms and positions are stored.

WITH_OFFSETS

public static final Field.TermVector WITH_OFFSETS

Terms and character offsets are stored.

WITH_POSITIONS_OFFSETS

public static final Field.TermVector WITH_POSITIONS_OFFSETS

Terms, positions, and character offsets are stored. The fast vector highlighter requires with_positions_offsets

WARNING: Setting with_positions_offsets will double the size of a field’s index.

Method Detail

values

public static Field.TermVector[] 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.TermVector c : Field.TermVector.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.TermVector 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.TermVector>