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

Class FunctionalBoost

java.lang.Object

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

All Implemented Interfaces:

Boost

public class FunctionalBoost
extends Object
implements Boost

Represents a functional boost on a search field

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

Method Summary

Modifier and Type	Method	Description
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.Operation	getOperation()	The arithmetic operation used to combine the original document score with your boost value.
Boost.BoostType	getType()	Type of boost
FunctionalBoost	setFactor(BigDecimal factor)	Alter the impact of a boost on the score of a document.
FunctionalBoost	setFunction(Boost.Function function)	Type of function to calculate the boost value.
FunctionalBoost	setName(String name)	Set the name of the boost
FunctionalBoost	setOperation(Boost.Operation operation)	The arithmetic operation used to combine the original document score with your boost value.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionalBoost

public FunctionalBoost()

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

getFunction

public Boost.Function getFunction()

Type of function to calculate the boost value. Can be linear, exponential, or gaussian. All functions decay rapidly towards 0 after about 2 days because the decay scale is 1 day.

Returns:

The function

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

getName

public String getName()

Description copied from interface: Boost

The name of the boost

Specified by:

getName in interface Boost

Returns:

the name

setFunction

public FunctionalBoost setFunction(Boost.Function function)

Type of function to calculate the boost value. Can be linear, exponential, or gaussian. All functions decay rapidly towards 0 after about 2 days because the decay scale is 1 day.

Parameters:

function - The function to calculate the boost value

Returns:

this.

setOperation

public FunctionalBoost 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 used to combine the original document with your boost

Returns:

this.

setFactor

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

setName

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