Package org.elasticsearch.search.rescore

Enum Class QueryRescoreMode

java.lang.Object

java.lang.Enum<QueryRescoreMode>

org.elasticsearch.search.rescore.QueryRescoreMode

All Implemented Interfaces:

Serializable, Comparable<QueryRescoreMode>, Constable, Writeable

public enum QueryRescoreMode
extends Enum<QueryRescoreMode>
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
Max
Min
Multiply
Total

Method Summary

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

Avg

public static final QueryRescoreMode Avg

Max

public static final QueryRescoreMode Max

Min

public static final QueryRescoreMode Min

Total

public static final QueryRescoreMode Total

Multiply

public static final QueryRescoreMode Multiply

Method Details

values

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

combine

public abstract float combine(float primary,
 float secondary)

readFromStream

public static QueryRescoreMode 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

fromString

public static QueryRescoreMode fromString(String scoreMode)

toString

public String toString()

Overrides:

toString in class Enum<QueryRescoreMode>