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

Class TextValueBoost

java.lang.Object

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

All Implemented Interfaces:

Boost

public class TextValueBoost
extends Object
implements Boost

Represents a boost based on the value of a text 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
TextValueBoost()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BigDecimal	getFactor()	Alter the impact of a boost on the score of a document.
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
List<String>	getValue()	The value to exact match on.
int	hashCode()
TextValueBoost	setFactor(BigDecimal factor)	Alter the impact of a boost on the score of a document.
TextValueBoost	setName(String name)	Set the name of the boost
TextValueBoost	setOperation(Boost.Operation operation)	The arithmetic operation used to combine the original document score with your boost value.
TextValueBoost	setValue(List<String> value)	The value to exact match on.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextValueBoost

public TextValueBoost()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

Description copied from interface: Boost

The name of the boost

Specified by:

getName in interface Boost

Returns:

the name

getValue

public List<String> getValue()

The value to exact match on.

Returns:

the values

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 TextValueBoost 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.

setValue

public TextValueBoost setValue(List<String> value)

The value to exact match on.

Parameters:

value - One or more exact values to match on

Returns:

this.

setOperation

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