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

Enum Boost.BoostType

java.lang.Object

java.lang.Enum<Boost.BoostType>

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

All Implemented Interfaces:

Serializable, Comparable<Boost.BoostType>

Enclosing interface:

Boost

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

The boosting types that are available

Enum Constant Summary

Enum Constants

Enum Constant	Description
FUNCTIONAL	A functional boost will apply a function to the overall document score.
PROXIMITY	A Boost on the difference of a document value and a given value from the center parameter.
VALUE	A Value Boost will boost the score of a document based on a direct value match.

Method Summary

Modifier and Type	Method	Description
static Boost.BoostType	findByValue(String value)	Get a BoostType by value
String	getValue()	Get the text representation of the enum
static Boost.BoostType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Boost.BoostType[]	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

FUNCTIONAL

public static final Boost.BoostType FUNCTIONAL

A functional boost will apply a function to the overall document score. Available on number fields

VALUE

public static final Boost.BoostType VALUE

A Value Boost will boost the score of a document based on a direct value match. Available on text, number, and date fields.

PROXIMITY

public static final Boost.BoostType PROXIMITY

A Boost on the difference of a document value and a given value from the center parameter. Available on number and geolocation fields.
aka A Proximity Boost, but with a timeframe as the center instead of a coordinate. Use Recency Boosts to boost newer documents.

Method Detail

values

public static Boost.BoostType[] 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.BoostType c : Boost.BoostType.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.BoostType 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.BoostType findByValue(String value)

Get a BoostType by value

Parameters:

value - The value to lookup

Returns:

The BoostType, otherwise it will throw an exception

getValue

public String getValue()

Get the text representation of the enum

Returns:

The text value