Package org.elasticsearch.search.sort

Enum Class SortMode

java.lang.Object

java.lang.Enum<SortMode>

org.elasticsearch.search.sort.SortMode

All Implemented Interfaces:

Serializable, Comparable<SortMode>, Constable, Writeable

public enum SortMode
extends 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

Enum.EnumDesc<E extends 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(String str)
static SortMode	readFromStream(StreamInput in)
String	toString()
static SortMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortMode[]	values()	Returns an array containing the constants of this enum class, 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 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 SortMode 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

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

readFromStream

public static SortMode readFromStream(StreamInput in)
                               throws IOException

Throws:

IOException

fromString

public static SortMode fromString(String str)

toString

public String toString()

Overrides:

toString in class Enum<SortMode>