Package org.elasticsearch.search.aggregations.support

Enum Class ValueType

java.lang.Object
java.lang.Enum<ValueType>
org.elasticsearch.search.aggregations.support.ValueType
All Implemented Interfaces:
Serializable, Comparable<ValueType>, Constable, Writeable
public enum ValueType extends Enum<ValueType> implements Writeable

  • 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.xcontent.ParseField VALUE_TYPE

  • Method Details

    • values

      public static ValueType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ValueType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getPreferredName

      public 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(String type)

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ValueType>

    • readFromStream

      public static ValueType readFromStream(StreamInput in) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException