com.datastax.dse.driver.api.core.data.geometry

Interface Point

All Superinterfaces:

Geometry

public interface Point
extends Geometry

The driver-side representation of DSE's Point.

This is a zero-dimensional object that represents a specific (X,Y) location in a two-dimensional XY-plane. In case of Geographic Coordinate Systems, the X coordinate is the longitude and the Y is the latitude.

The default implementation returned by the driver is immutable.

Method Summary

Modifier and Type	Method and Description
static Point	fromCoordinates(double x, double y) Creates a new point.
static Point	fromGeoJson(String source) Creates a point from a GeoJSON Point representation.
static Point	fromWellKnownBinary(ByteBuffer source) Creates a point from its Well-known Binary (WKB) representation.
static Point	fromWellKnownText(String source) Creates a point from its Well-known Text (WKT) representation.
double	X() Returns the X coordinate of this 2D point (or its longitude in Geographic Coordinate Systems).
double	Y() Returns the Y coordinate of this 2D point (or its latitude in Geographic Coordinate Systems).

Methods inherited from interface com.datastax.dse.driver.api.core.data.geometry.Geometry

asGeoJson, asWellKnownBinary, asWellKnownText, contains

Method Detail

fromWellKnownText

@NonNull
static Point fromWellKnownText(@NonNull
                                        String source)

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

Parameters:

source - the Well-known Text representation to parse.

Returns:

the point represented by the WKT.

Throws:

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

fromWellKnownBinary

@NonNull
static Point fromWellKnownBinary(@NonNull
                                          ByteBuffer source)

Creates a point from its Well-known Binary (WKB) representation.

Parameters:

source - the Well-known Binary representation to parse.

Returns:

the point represented by the WKB.

Throws:

IllegalArgumentException - if the provided ByteBuffer does not contain a valid Well-known Binary representation.

fromGeoJson

@NonNull
static Point fromGeoJson(@NonNull
                                  String source)

Creates a point from a GeoJSON Point representation.

Parameters:

source - the GeoJSON Point representation to parse.

Returns:

the point represented by the GeoJSON Point.

Throws:

IllegalArgumentException - if the string does not contain a valid GeoJSON Point representation.

fromCoordinates

@NonNull
static Point fromCoordinates(double x,
                                      double y)

Creates a new point.

Parameters:

x - The X coordinate of this point (or its longitude in Geographic Coordinate Systems).

y - The Y coordinate of this point (or its latitude in Geographic Coordinate Systems).

Returns:

the point represented by coordinates.

X

double X()

Returns the X coordinate of this 2D point (or its longitude in Geographic Coordinate Systems).

Y

double Y()

Returns the Y coordinate of this 2D point (or its latitude in Geographic Coordinate Systems).