de.julielab.elastic.query.components.data.aggregation

Enum AggregationCommand.OrderCommand.ReferenceType

java.lang.Object

java.lang.Enum<AggregationCommand.OrderCommand.ReferenceType>

de.julielab.elastic.query.components.data.aggregation.AggregationCommand.OrderCommand.ReferenceType

All Implemented Interfaces:

Serializable, Comparable<AggregationCommand.OrderCommand.ReferenceType>

Enclosing class:

AggregationCommand.OrderCommand

public static enum AggregationCommand.OrderCommand.ReferenceType
extends Enum<AggregationCommand.OrderCommand.ReferenceType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATION_MULTIVALUE Requires AggregationCommand.OrderCommand.metric to be set in order to obtain a single value to order by.
AGGREGATION_SINGLE_VALUE
COUNT
TERM

Method Summary

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

AGGREGATION_SINGLE_VALUE

public static final AggregationCommand.OrderCommand.ReferenceType AGGREGATION_SINGLE_VALUE

AGGREGATION_MULTIVALUE

public static final AggregationCommand.OrderCommand.ReferenceType AGGREGATION_MULTIVALUE

Requires AggregationCommand.OrderCommand.metric to be set in order to obtain a single value to order by.

COUNT

public static final AggregationCommand.OrderCommand.ReferenceType COUNT

TERM

public static final AggregationCommand.OrderCommand.ReferenceType TERM

Method Detail

values

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

Returns:

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

valueOf

public static AggregationCommand.OrderCommand.ReferenceType 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