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

Class GeolocationProximityBoost

java.lang.Object

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

All Implemented Interfaces:

Boost

public class GeolocationProximityBoost
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
GeolocationProximityBoost()

Method Summary

Modifier and Type	Method	Description
GeoLocation	getCenter()	The mode of the distribution, specified as a latitude-longitude pair
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()
Boost.BoostType	getType()	Type of boost
GeolocationProximityBoost	setCenter(GeoLocation center)	The mode of the distribution, specified as a latitude-longitude pair
GeolocationProximityBoost	setFactor(BigDecimal factor)	Alter the impact of a boost on the score of a document.
GeolocationProximityBoost	setFunction(Boost.Function function)	Type of function to calculate the boost value.
GeolocationProximityBoost	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

GeolocationProximityBoost

public GeolocationProximityBoost()

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

getFunction

public Boost.Function getFunction()

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

Returns:

The function

getCenter

public GeoLocation getCenter()

The mode of the distribution, specified as a latitude-longitude pair

Returns:

The geolocation center

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

Specified by:

setName in interface Boost

Returns:

this.

setFunction

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

setCenter

public GeolocationProximityBoost setCenter(GeoLocation center)

The mode of the distribution, specified as a latitude-longitude pair

Parameters:

center - The anchor point for the boost

Returns:

this.

setFactor

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