io.searchbox.core.search.aggregation

Enum AggregationField

java.lang.Object

java.lang.Enum<AggregationField>

io.searchbox.core.search.aggregation.AggregationField

All Implemented Interfaces:

Serializable, Comparable<AggregationField>

public enum AggregationField
extends Enum<AggregationField>

Author:

cfstout

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVG
BG_COUNT
BOTTOM_RIGHT
BOUNDS
BUCKETS
COUNT
DOC_COUNT
DOC_COUNT_ERROR_UPPER_BOUND
FROM
FROM_AS_STRING
KEY
KEY_AS_STRING
LAT
LON
MAX
MIN
SCORE
STD_DEVIATION
SUM
SUM_OF_SQUARES
SUM_OTHER_DOC_COUNT
TO
TO_AS_STRING
TOP_LEFT
UNIT
VALUE
VALUES
VARIANCE

Method Summary

Methods

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

VALUE

public static final AggregationField VALUE

BUCKETS

public static final AggregationField BUCKETS

KEY

public static final AggregationField KEY

KEY_AS_STRING

public static final AggregationField KEY_AS_STRING

DOC_COUNT

public static final AggregationField DOC_COUNT

FROM

public static final AggregationField FROM

TO

public static final AggregationField TO

FROM_AS_STRING

public static final AggregationField FROM_AS_STRING

TO_AS_STRING

public static final AggregationField TO_AS_STRING

SUM_OF_SQUARES

public static final AggregationField SUM_OF_SQUARES

VARIANCE

public static final AggregationField VARIANCE

STD_DEVIATION

public static final AggregationField STD_DEVIATION

BOUNDS

public static final AggregationField BOUNDS

TOP_LEFT

public static final AggregationField TOP_LEFT

BOTTOM_RIGHT

public static final AggregationField BOTTOM_RIGHT

LAT

public static final AggregationField LAT

LON

public static final AggregationField LON

UNIT

public static final AggregationField UNIT

VALUES

public static final AggregationField VALUES

SCORE

public static final AggregationField SCORE

BG_COUNT

public static final AggregationField BG_COUNT

COUNT

public static final AggregationField COUNT

MIN

public static final AggregationField MIN

MAX

public static final AggregationField MAX

AVG

public static final AggregationField AVG

SUM

public static final AggregationField SUM

DOC_COUNT_ERROR_UPPER_BOUND

public static final AggregationField DOC_COUNT_ERROR_UPPER_BOUND

SUM_OTHER_DOC_COUNT

public static final AggregationField SUM_OTHER_DOC_COUNT

Method Detail

values

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

Returns:

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

valueOf

public static AggregationField 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

toString

public String toString()

Overrides:

toString in class Enum<AggregationField>

equals

public boolean equals(String s)