Package co.elasticsearch.enterprisesearch.client.model.request.search.boost

Enum Boost.Function

java.lang.Object

java.lang.Enum<Boost.Function>

co.elasticsearch.enterprisesearch.client.model.request.search.boost.Boost.Function

All Implemented Interfaces:

Serializable, Comparable<Boost.Function>

Enclosing interface:

Boost

public static enum Boost.Function
extends Enum<Boost.Function>

Decay functions score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin
See Supported Decay Functions

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPONENTIAL	Exponential decay
GAUSSIAN	Normal decay
LINEAR	Linear decay
LOGARITHMIC	Logarithmic decay

Method Summary

Modifier and Type	Method	Description
static Boost.Function	findByValue(String value)	Get a Function by value
String	getValue()	Get the text representation of the enum
static Boost.Function	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Boost.Function[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

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

LINEAR

public static final Boost.Function LINEAR

Linear decay

EXPONENTIAL

public static final Boost.Function EXPONENTIAL

Exponential decay

GAUSSIAN

public static final Boost.Function GAUSSIAN

Normal decay

LOGARITHMIC

public static final Boost.Function LOGARITHMIC

Logarithmic decay

Method Detail

values

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

Returns:

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

valueOf

public static Boost.Function valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findByValue

public static Boost.Function findByValue(String value)

Get a Function by value

Parameters:

value - The value to lookup

Returns:

The Function, otherwise it will throw an exception

getValue

public String getValue()

Get the text representation of the enum

Returns:

The text value