Package org.elasticsearch.search.suggest

Enum SortBy

java.lang.Object

java.lang.Enum<SortBy>

org.elasticsearch.search.suggest.SortBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortBy>, Writeable

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

An enum representing the valid sorting options

Nested Class Summary

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
FREQUENCY	Sort should first be based on document frequency, then score and then the term itself.
SCORE	Sort should first be based on score, then document frequency and then the term itself.

Method Summary

Modifier and Type	Method	Description
static SortBy	readFromStream(StreamInput in)
static SortBy	resolve(java.lang.String str)
static SortBy	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SortBy[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCORE

public static final SortBy SCORE

Sort should first be based on score, then document frequency and then the term itself.

FREQUENCY

public static final SortBy FREQUENCY

Sort should first be based on document frequency, then score and then the term itself.

Method Detail

values

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

Returns:

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

valueOf

public static SortBy 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 SortBy readFromStream(StreamInput in)
                             throws java.io.IOException

Throws:

java.io.IOException

resolve

public static SortBy resolve(java.lang.String str)