de.julielab.elastic.query.components.data

Enum FieldTermItem.ValueType

java.lang.Object

java.lang.Enum<FieldTermItem.ValueType>

de.julielab.elastic.query.components.data.FieldTermItem.ValueType

All Implemented Interfaces:

Serializable, Comparable<FieldTermItem.ValueType>

Enclosing class:

FieldTermItem

public static enum FieldTermItem.ValueType
extends Enum<FieldTermItem.ValueType>

The different types of aggregation values that can be associated with an index field term. This includes its frequency in a particular query or the maximum score of a document this term occurred in.

Author:

faessler

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNT The term count is encoded as a Long in values(), if present.
MAX_DOC_SCORE The maximum document score for this term item is encoded as a Double in values(), if present.

Method Summary

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

COUNT

public static final FieldTermItem.ValueType COUNT

The term count is encoded as a Long in values(), if present.

MAX_DOC_SCORE

public static final FieldTermItem.ValueType MAX_DOC_SCORE

The maximum document score for this term item is encoded as a Double in values(), if present.

Method Detail

values

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

Returns:

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

valueOf

public static FieldTermItem.ValueType 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