Package org.elasticsearch.search.aggregations.support

Enum ValueType

java.lang.Object

java.lang.Enum<ValueType>

org.elasticsearch.search.aggregations.support.ValueType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ValueType>, java.lang.constant.Constable, Writeable

public enum ValueType
extends java.lang.Enum<ValueType>
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOLEAN
DATE
DOUBLE
GEOPOINT
IP
LONG
NUMBER
NUMERIC
RANGE
STRING

Field Summary

Fields

Modifier and Type	Field	Description
static org.elasticsearch.common.ParseField	VALUE_TYPE

Method Summary

Modifier and Type	Method	Description
DocValueFormat	defaultFormat()
java.lang.String	getPreferredName()
ValuesSourceType	getValuesSourceType()
boolean	isA(ValueType valueType)	This is a bit of a hack to mirror the old ValueType behavior, which would allow a rough compatibility between types.
boolean	isNotA(ValueType valueType)
static ValueType	lenientParse(java.lang.String type)
static ValueType	readFromStream(StreamInput in)
java.lang.String	toString()
static ValueType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ValueType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRING

public static final ValueType STRING

LONG

public static final ValueType LONG

DOUBLE

public static final ValueType DOUBLE

NUMBER

public static final ValueType NUMBER

DATE

public static final ValueType DATE

IP

public static final ValueType IP

NUMERIC

public static final ValueType NUMERIC

GEOPOINT

public static final ValueType GEOPOINT

BOOLEAN

public static final ValueType BOOLEAN

RANGE

public static final ValueType RANGE

Field Details

VALUE_TYPE

public static final org.elasticsearch.common.ParseField VALUE_TYPE

Method Details

values

public static ValueType[] values()

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

Returns:

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

valueOf

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

getPreferredName

public java.lang.String getPreferredName()

getValuesSourceType

public ValuesSourceType getValuesSourceType()

isA

public boolean isA(ValueType valueType)

This is a bit of a hack to mirror the old ValueType behavior, which would allow a rough compatibility between types. This behavior is being phased out in the aggregations framework, in favor of explicitly listing supported types, but we haven't gotten to fixing composite yet.

Parameters:

valueType - The value type the user suggested

Returns:

True iff the two value types are interchangeable

isNotA

public boolean isNotA(ValueType valueType)

defaultFormat

public DocValueFormat defaultFormat()

lenientParse

public static ValueType lenientParse(java.lang.String type)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ValueType>

readFromStream

public static ValueType readFromStream(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException