com.attivio.sdk.search.fields

Class GeoDistance

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

com.attivio.sdk.search.fields.GeoDistance

All Implemented Interfaces:

Serializable, Cloneable

public class GeoDistance
extends UnaryFieldExpression

Computes 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

Modifier and Type	Field and Description
static DistanceUnits	DEFAULT_DISTANCE_UNITS

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
GeoDistance(FieldExpression expression, double latitude, double longitude) Construct a new FieldFunction to apply an aggregation function to another expression.
GeoDistance(FieldExpression expression, double latitude, double longitude, DistanceUnits distanceUnits, String alias) Construct a new FieldFunction to apply an aggregation function to another expression with an alias.
GeoDistance(FieldExpression expression, double latitude, double longitude, String alias) Construct a new FieldFunction to apply an aggregation function to another expression with an alias.
GeoDistance(String fieldName, double latitude, double longitude) Calculate the geo distance.
GeoDistance(String fieldName, double latitude, double longitude, String alias) Calculate the geo distance.
GeoDistance(String fieldName, Point center, DistanceUnits units)

Method Summary

Modifier and Type	Method and Description
GeoDistance	clone()
protected GeoDistance	clone(FieldExpression e) Create a new instance of this FieldExpression, with a different argument.
DistanceUnits	getDistanceUnits() Get the units the distance will be returned in (meters, kilometers, etc)
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	setDistanceUnits(DistanceUnits units) Get the units the distance will be returned in (meters, kilometers, etc)
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

Field Detail

DEFAULT_DISTANCE_UNITS

public static final DistanceUnits DEFAULT_DISTANCE_UNITS

Constructor Detail

GeoDistance

public GeoDistance(String fieldName,
                   Point center,
                   DistanceUnits units)

GeoDistance

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

Calculate the geo distance.

GeoDistance

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

Calculate the geo distance.

GeoDistance

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

Construct a new FieldFunction to apply an aggregation function to another expression.

GeoDistance

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

Construct a new FieldFunction to apply an aggregation function to another expression with an alias.

GeoDistance

public GeoDistance(FieldExpression expression,
                   double latitude,
                   double longitude,
                   DistanceUnits distanceUnits,
                   String alias)

Construct a new FieldFunction to apply an aggregation function to another expression with an alias.

Method Detail

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

getDistanceUnits

public DistanceUnits getDistanceUnits()

Get the units the distance will be returned in (meters, kilometers, etc)

setDistanceUnits

public void setDistanceUnits(DistanceUnits units)

Get the units the distance will be returned in (meters, kilometers, etc)

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

Overrides:

clone in class UnaryFieldExpression

clone

protected GeoDistance clone(FieldExpression e)

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

Overrides:

clone in class UnaryFieldExpression