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

Class NumericValueBoost

java.lang.Object

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

All Implemented Interfaces:

Boost

public class NumericValueBoost
extends Object
implements Boost

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
NumericValueBoost()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getFactor()	Alter the impact of a boost on the score of a document.
String	getName()
Boost.Operation	getOperation()	The arithmetic operation used to combine the original document score with your boost value.
Boost.BoostType	getType()	Type of boost
List<BigDecimal>	getValue()	The value to exact match on.
NumericValueBoost	setFactor(BigDecimal factor)	Alter the impact of a boost on the score of a document.
NumericValueBoost	setName(String name)
NumericValueBoost	setOperation(Boost.Operation operation)	The arithmetic operation used to combine the original document score with your boost value.
NumericValueBoost	setValue(List<BigDecimal> value)	The value to exact match on.

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericValueBoost

public NumericValueBoost()

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()

Specified by:

getName in interface Boost

getValue

public List<BigDecimal> getValue()

The value to exact match on.

Returns:

The values to match on

getOperation

public Boost.Operation getOperation()

The arithmetic operation used to combine the original document score with your boost value. Can be add or multiply. Defaults to add.

Returns:

the operation

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 NumericValueBoost setName(String name)

Specified by:

setName in interface Boost

Returns:

this.

setValue

public NumericValueBoost setValue(List<BigDecimal> value)

The value to exact match on.

Parameters:

value - One or more values to match on

Returns:

this.

setOperation

public NumericValueBoost setOperation(Boost.Operation operation)

The arithmetic operation used to combine the original document score with your boost value. Can be add or multiply. Defaults to add.

Parameters:

operation - The operation to use to boost the score

Returns:

this.

setFactor

public NumericValueBoost 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.