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

Enum Class FieldValueFactorFunction.Modifier

java.lang.Object

java.lang.Enum<FieldValueFactorFunction.Modifier>

org.elasticsearch.common.lucene.search.function.FieldValueFactorFunction.Modifier

All Implemented Interfaces:

Serializable, Comparable<FieldValueFactorFunction.Modifier>, Constable, Writeable

Enclosing class:

FieldValueFactorFunction

public static enum FieldValueFactorFunction.Modifier
extends Enum<FieldValueFactorFunction.Modifier>
implements Writeable

The Type class encapsulates the modification types that can be applied to the score/value product.

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
LN
LN1P
LN2P
LOG
LOG1P
LOG2P
NONE
RECIPROCAL
SQRT
SQUARE

Method Summary

Modifier and Type	Method	Description
abstract double	apply(double n)
static FieldValueFactorFunction.Modifier	fromString(String modifier)
static FieldValueFactorFunction.Modifier	readFromStream(StreamInput in)
String	toString()
static FieldValueFactorFunction.Modifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FieldValueFactorFunction.Modifier[]	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

NONE

public static final FieldValueFactorFunction.Modifier NONE

LOG

public static final FieldValueFactorFunction.Modifier LOG

LOG1P

public static final FieldValueFactorFunction.Modifier LOG1P

LOG2P

public static final FieldValueFactorFunction.Modifier LOG2P

LN

public static final FieldValueFactorFunction.Modifier LN

LN1P

public static final FieldValueFactorFunction.Modifier LN1P

LN2P

public static final FieldValueFactorFunction.Modifier LN2P

SQUARE

public static final FieldValueFactorFunction.Modifier SQUARE

SQRT

public static final FieldValueFactorFunction.Modifier SQRT

RECIPROCAL

public static final FieldValueFactorFunction.Modifier RECIPROCAL

Method Details

values

public static FieldValueFactorFunction.Modifier[] 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 FieldValueFactorFunction.Modifier 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

apply

public abstract double apply(double n)

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 FieldValueFactorFunction.Modifier readFromStream(StreamInput in)
                                                        throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Enum<FieldValueFactorFunction.Modifier>

fromString

public static FieldValueFactorFunction.Modifier fromString(String modifier)