com.datastax.driver.dse.geometry

Class Distance

java.lang.Object

com.datastax.driver.dse.geometry.Geometry

com.datastax.driver.dse.geometry.Distance

All Implemented Interfaces:

Serializable

public class Distance
extends Geometry

The driver-side representation of DSE's Geo.distance.

This is a circle in a two-dimensional XY plane represented by its center point and radius. It is used as a search criteria to determine whether or not another geospatial object lies within a circular area.

Note that this shape has no equivalent in the OGC and GeoJSON standards: as a consequence, asWellKnownText() returns a custom format, and asWellKnownBinary(), and asGeoJson() are not supported.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Distance(Point center, double radius) Creates a new distance with the given center and radius.

Method Summary

Modifier and Type	Method and Description
String	asGeoJson() The distance type has no equivalent in the GeoJSON standard: this method throws an UnsupportedOperationException.
ByteBuffer	asWellKnownBinary() The distance type has no equivalent in the OGC standard: this method throws an UnsupportedOperationException.
String	asWellKnownText() Returns a Well-known Text (WKT) representation of this geospatial type.
boolean	contains(Geometry geometry) Tests whether this geospatial type instance contains another instance.
boolean	equals(Object o)
static Distance	fromWellKnownText(String source) Creates a distance from its Well-known Text (WKT) representation.
Point	getCenter()
double	getRadius()
int	hashCode()

Methods inherited from class com.datastax.driver.dse.geometry.Geometry

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Distance

public Distance(Point center,
                double radius)

Creates a new distance with the given center and radius.

Parameters:

center - The center point.

radius - The radius of the circle representing distance.

Method Detail

fromWellKnownText

public static Distance fromWellKnownText(String source)

Creates a distance from its Well-known Text (WKT) representation.

Parameters:

source - the Well-known Text representation to parse.

Returns:

the point represented by the WKT.

Throws:

InvalidTypeException - if the string does not contain a valid Well-known Text representation.

See Also:

asWellKnownText()

getCenter

public Point getCenter()

Returns:

The center point of the circle representing this distance.

getRadius

public double getRadius()

Returns:

The radius of the circle representing this distance.

asWellKnownText

public String asWellKnownText()

Returns a Well-known Text (WKT) representation of this geospatial type.

Since there is no Well-known Text specification for Distance, this returns a custom format of:

DISTANCE((center.x center.y) radius)

Overrides:

asWellKnownText in class Geometry

Returns:

a Well-known Text representation of this object.

asWellKnownBinary

public ByteBuffer asWellKnownBinary()

The distance type has no equivalent in the OGC standard: this method throws an UnsupportedOperationException.

Overrides:

asWellKnownBinary in class Geometry

Returns:

a Well-known Binary representation of this object.

asGeoJson

public String asGeoJson()

The distance type has no equivalent in the GeoJSON standard: this method throws an UnsupportedOperationException.

Overrides:

asGeoJson in class Geometry

Returns:

a JSON representation of this object.

equals

public boolean equals(Object o)

Overrides:

equals in class Geometry

hashCode

public int hashCode()

Overrides:

hashCode in class Geometry

contains

public boolean contains(Geometry geometry)

Description copied from class: Geometry

Tests whether this geospatial type instance contains another instance.

Overrides:

contains in class Geometry

Parameters:

geometry - the other instance.

Returns:

whether this contains other.