com.attivio.sdk.search.fields

Class GeoBoost

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

com.attivio.sdk.search.fields.GeoBoost

All Implemented Interfaces:

Serializable, Cloneable

public class GeoBoost
extends UnaryFieldExpression

Computes a boost score based on the geographical distance from a center point.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.fields.FieldExpression

FieldExpression.StringMode

Field Summary

Fields inherited from class com.attivio.sdk.search.fields.UnaryFieldExpression

expression

Fields inherited from class com.attivio.sdk.search.fields.FieldExpression

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
GeoBoost(FieldExpression expression, double latitude, double longitude) Constructor.
GeoBoost(FieldExpression expression, double latitude, double longitude, String alias) Constructor.
GeoBoost(String fieldName, double latitude, double longitude) Constructor.
GeoBoost(String fieldName, double latitude, double longitude, String alias) Constructor.

Method Summary

Modifier and Type	Method and Description
GeoBoost	clone()
protected GeoBoost	clone(FieldExpression e) Create a new instance of this FieldExpression, with a different argument.
double	getLatitude() Get the center latitude to calculate distance to.
double	getLongitude() Get the center longitude to calculate distance to.
SchemaField.Type	getType(Schema schema) Resolve the type for this expression.
int	hashCode()
protected boolean	parametersEqual(FieldExpression other) Returns true if other's parameters are the same as this.
void	setLatitude(double latitude) Set the center latitude to calculate distance to.
void	setLongitude(double longitude) Set the center longitude to calculate distance to.
protected void	toString(StringBuilder buffer, FieldExpression.StringMode mode) Writes the string representation of this field expression to buffer.

Methods inherited from class com.attivio.sdk.search.fields.UnaryFieldExpression

equalsIgnoreAlias, getExpression, getFieldName, hasChildren, isConstant, rewrite, rewriteChildren, setExpression

Methods inherited from class com.attivio.sdk.search.fields.FieldExpression

as, containsAlias, copyOf, equals, equalsIgnoreAlias, getAlias, getDefaultAlias, handleFieldExpression, isConstant, quote, rewrite, setAlias, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GeoBoost

public GeoBoost(String fieldName,
                double latitude,
                double longitude)

Constructor.

GeoBoost

public GeoBoost(String fieldName,
                double latitude,
                double longitude,
                String alias)

Constructor.

GeoBoost

public GeoBoost(FieldExpression expression,
                double latitude,
                double longitude)

Constructor.

GeoBoost

public GeoBoost(FieldExpression expression,
                double latitude,
                double longitude,
                String alias)

Constructor.

Method Detail

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

getLatitude

public double getLatitude()

Get the center latitude to calculate distance to.

setLatitude

public void setLatitude(double latitude)

Set the center latitude to calculate distance to.

getLongitude

public double getLongitude()

Get the center longitude to calculate distance to.

setLongitude

public void setLongitude(double longitude)

Set the center longitude to calculate distance to.

toString

protected void toString(StringBuilder buffer,
                        FieldExpression.StringMode mode)

Writes the string representation of this field expression to buffer.

NOTE: the alias will not be written to buffer by this function.

Specified by:

toString in class FieldExpression

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryFieldExpression

parametersEqual

protected boolean parametersEqual(FieldExpression other)

Returns true if other's parameters are the same as this.

Specified by:

parametersEqual in class UnaryFieldExpression

clone

public GeoBoost clone()

Overrides:

clone in class UnaryFieldExpression

clone

protected GeoBoost clone(FieldExpression e)

Create a new instance of this FieldExpression, with a different argument.

Overrides:

clone in class UnaryFieldExpression