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

Class NumberProximityBoost

java.lang.Object

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

All Implemented Interfaces:

Boost

public class NumberProximityBoost
extends Object
implements Boost

Represents a boost based on the numeric proximity to a central value

Nested Class Summary

Nested classes/interfaces inherited from interface co.elasticsearch.enterprisesearch.client.model.request.search.boost.Boost

Boost.BoostType, Boost.Function, Boost.Operation

Constructor Summary

Constructors

Constructor	Description
NumberProximityBoost()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getCenter()	The mode of the distribution, scores based on proximity to this value
BigDecimal	getFactor()	Alter the impact of a boost on the score of a document.
Boost.Function	getFunction()	Type of function to calculate the boost value.
String	getName()	The name of the boost
Boost.BoostType	getType()	Type of boost
NumberProximityBoost	setCenter(BigDecimal center)	The mode of the distribution, scores based on proximity to this value
NumberProximityBoost	setFactor(BigDecimal factor)	Alter the impact of a boost on the score of a document.
NumberProximityBoost	setFunction(Boost.Function function)	Type of function to calculate the boost value.
NumberProximityBoost	setName(String name)	Set the name of the boost

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NumberProximityBoost

public NumberProximityBoost()

Method Detail

getType

public Boost.BoostType getType()

Description copied from interface: Boost

Type of boost

Specified by:

getType in interface Boost

Returns:

The boost type

getName

public String getName()

Description copied from interface: Boost

The name of the boost

Specified by:

getName in interface Boost

Returns:

the name

getCenter

public BigDecimal getCenter()

The mode of the distribution, scores based on proximity to this value

Returns:

The center

getFunction

public Boost.Function getFunction()

Type of function to calculate the boost value. Can be linear, exponential, or gaussian.

Returns:

the function

getFactor

public BigDecimal getFactor()

Description copied from interface: Boost

Alter the impact of a boost on the score of a document. Must be between 0 and 10. Defaults to 1.0. A negative factor or fractional factor will not deboost a result. The factor parameter multiplies the value of the boost but does not significantly affect the decay function scale.

Specified by:

getFactor in interface Boost

Returns:

The factor

setName

public NumberProximityBoost setName(String name)

Description copied from interface: Boost

Set the name of the boost

Specified by:

setName in interface Boost

Parameters:

name - The boost name

Returns:

this.

setCenter

public NumberProximityBoost setCenter(BigDecimal center)

The mode of the distribution, scores based on proximity to this value

Parameters:

center - The mode of the distribution, scores based on proximity to this value

Returns:

this.

setFunction

public NumberProximityBoost setFunction(Boost.Function function)

Type of function to calculate the boost value. Can be linear, exponential, or gaussian.

Parameters:

function - The function to calculate the boost

Returns:

this.

setFactor

public NumberProximityBoost setFactor(BigDecimal factor)

Description copied from interface: Boost

Alter the impact of a boost on the score of a document. Must be between 0 and 10. Defaults to 1.0. A negative factor or fractional factor will not deboost a result. The factor parameter multiplies the value of the boost but does not significantly affect the decay function scale.

Specified by:

setFactor in interface Boost

Parameters:

factor - A value between (inclusive) 0.0 and 10.0

Returns:

this.