Package org.elasticsearch.common.lucene.search.function

Enum Class FunctionScoreQuery.ScoreMode

java.lang.Object

java.lang.Enum<FunctionScoreQuery.ScoreMode>

org.elasticsearch.common.lucene.search.function.FunctionScoreQuery.ScoreMode

All Implemented Interfaces:

Serializable, Comparable<FunctionScoreQuery.ScoreMode>, Constable, Writeable

Enclosing class:

FunctionScoreQuery

public static enum FunctionScoreQuery.ScoreMode
extends Enum<FunctionScoreQuery.ScoreMode>
implements Writeable

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
FIRST
MAX
MIN
MULTIPLY
SUM

Method Summary

Modifier and Type	Method	Description
static FunctionScoreQuery.ScoreMode	fromString(String scoreMode)
static FunctionScoreQuery.ScoreMode	readFromStream(StreamInput in)
static FunctionScoreQuery.ScoreMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FunctionScoreQuery.ScoreMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIRST

public static final FunctionScoreQuery.ScoreMode FIRST

AVG

public static final FunctionScoreQuery.ScoreMode AVG

MAX

public static final FunctionScoreQuery.ScoreMode MAX

SUM

public static final FunctionScoreQuery.ScoreMode SUM

MIN

public static final FunctionScoreQuery.ScoreMode MIN

MULTIPLY

public static final FunctionScoreQuery.ScoreMode MULTIPLY

Method Details

values

public static FunctionScoreQuery.ScoreMode[] 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 FunctionScoreQuery.ScoreMode 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 FunctionScoreQuery.ScoreMode readFromStream(StreamInput in)
                                                   throws IOException

Throws:

IOException

fromString

public static FunctionScoreQuery.ScoreMode fromString(String scoreMode)