org.elasticsearch.common.lucene.search.function

Enum CombineFunction

java.lang.Object

java.lang.Enum<CombineFunction>

org.elasticsearch.common.lucene.search.function.CombineFunction

All Implemented Interfaces:

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

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

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 and Description
AVG
MAX
MIN
MULTIPLY
REPLACE
SUM

Method Summary

Modifier and Type	Method and Description
abstract float	combine(double queryScore, double funcScore, double maxBoost)
abstract org.apache.lucene.search.Explanation	explain(org.apache.lucene.search.Explanation queryExpl, org.apache.lucene.search.Explanation funcExpl, float maxBoost)
static CombineFunction	fromString(java.lang.String combineFunction)
static CombineFunction	readFromStream(StreamInput in)
static CombineFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CombineFunction[]	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

MULTIPLY

public static final CombineFunction MULTIPLY

REPLACE

public static final CombineFunction REPLACE

SUM

public static final CombineFunction SUM

AVG

public static final CombineFunction AVG

MIN

public static final CombineFunction MIN

MAX

public static final CombineFunction MAX

Method Detail

values

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

Returns:

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

valueOf

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

combine

public abstract float combine(double queryScore,
                              double funcScore,
                              double maxBoost)

explain

public abstract org.apache.lucene.search.Explanation explain(org.apache.lucene.search.Explanation queryExpl,
                                                             org.apache.lucene.search.Explanation funcExpl,
                                                             float maxBoost)

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

Throws:

java.io.IOException

fromString

public static CombineFunction fromString(java.lang.String combineFunction)