Package org.elasticsearch.search.sort

Enum SortMode

java.lang.Object
java.lang.Enum<SortMode>
org.elasticsearch.search.sort.SortMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SortMode>, java.lang.constant.Constable, Writeable
public enum SortMode
extends java.lang.Enum<SortMode>
implements Writeable
Elasticsearch supports sorting by array or multi-valued fields. The SortMode option controls what array value is picked for sorting the document it belongs to. The mode option can have the following values:
  • min - Pick the lowest value.
  • max - Pick the highest value.
  • sum - Use the sum of all values as sort value. Only applicable for number based array fields.
  • avg - Use the average of all values as sort value. Only applicable for number based array fields.
  • median - Use the median of all values as sort value. Only applicable for number based array fields.

  • 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
    AVG
    Use the average of all values as sort value.
    MAX
    pick the highest value
    MEDIAN
    Use the median of all values as sort value.
    MIN
    pick the lowest value
    SUM
    Use the sum of all values as sort value.

  • Method Summary

    Modifier and Type Method Description
    static SortMode fromString​(java.lang.String str)  
    static SortMode readFromStream​(StreamInput in)  
    java.lang.String toString()  
    static SortMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SortMode[] 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

    • MIN

      public static final SortMode MIN
      pick the lowest value

    • MAX

      public static final SortMode MAX
      pick the highest value

    • SUM

      public static final SortMode SUM
      Use the sum of all values as sort value. Only applicable for number based array fields.

    • AVG

      public static final SortMode AVG
      Use the average of all values as sort value. Only applicable for number based array fields.

    • MEDIAN

      public static final SortMode MEDIAN
      Use the median of all values as sort value. Only applicable for number based array fields.

  • Method Details

    • values

      public static SortMode[] 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 SortMode 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

    • 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

    • readFromStream

      public static SortMode readFromStream​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • fromString

      public static SortMode fromString​(java.lang.String str)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Enum<SortMode>