com.sap.cloud.server.odata

Class GeographyPoint

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.GeospatialValue

com.sap.cloud.server.odata.GeographyValue

com.sap.cloud.server.odata.GeographyPoint

public class GeographyPoint
extends GeographyValue

A geography point.

Field Summary

Fields inherited from class com.sap.cloud.server.odata.GeographyValue

DEFAULT_SRID

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
GeographyPoint() Constructor

Method Summary

Modifier and Type	Method and Description
static GeographyPoint	castOptional(DataValue value) For internal use only.
static GeographyPoint	castRequired(DataValue value) For internal use only.
java.lang.String	formatWKT() See formatWKT(boolean).
java.lang.String	formatWKT(boolean sridRequired) Return this value formatted in OData WKT (well-known text) format.
PointCoordinates	getCoordinates() Return the coordinates of this value.
DataType	getDataType() Return data type of the wrapped value.
static GeographyPoint	parse(java.lang.String text) Return a value parsed from text in GeoJSON format.
static GeographyPoint	parseWKT(java.lang.String text) See parseWKT(String, boolean).
static GeographyPoint	parseWKT(java.lang.String text, boolean sridRequired) Return a value parsed from OData WKT (well-known text) format.
void	setCoordinates(PointCoordinates value) Set the coordinates of this value.
static GeographyPoint	withLatitudeLongitude(double latitude, double longitude) Return 2D geography point.
static GeographyPoint	withXY(double x, double y) Return 2D geography point.
static GeographyPoint	withXYM(double x, double y, double m) Return 2D geography point with measure.
static GeographyPoint	withXYZ(double x, double y, double z) Return 3D geography point.
static GeographyPoint	withXYZM(double x, double y, double z, double m) Return 3D geography point with measure.

Methods inherited from class com.sap.cloud.server.odata.GeographyValue

getSrsCode, getSrsName, parseAny, parseAnyWKT, parseAnyWKT, setSrsCode, setSrsName, toString

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

GeographyPoint

public GeographyPoint()

Constructor

Method Detail

castOptional

public static GeographyPoint castOptional(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

castRequired

public static GeographyPoint castRequired(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

formatWKT

public java.lang.String formatWKT()

See formatWKT(boolean).

Overrides:

formatWKT in class GeographyValue

Returns:

(see linked method).

formatWKT

public java.lang.String formatWKT(boolean sridRequired)

Return this value formatted in OData WKT (well-known text) format.

See Also:

https://en.wikipedia.org/wiki/Well-known_text, OData ABNF.

Specified by:

formatWKT in class GeographyValue

Parameters:

sridRequired - Is SRID prefix required?

Returns:

This value formatted in OData WKT (well-known text) format.

getCoordinates

public PointCoordinates getCoordinates()

Return the coordinates of this value.

Returns:

The coordinates of this value.

getDataType

public DataType getDataType()

Return data type of the wrapped value.

Specified by:

getDataType in class DataValue

Returns:

Data type of the wrapped value.

parse

public static GeographyPoint parse(java.lang.String text)

Return a value parsed from text in GeoJSON format.

Parameters:

text - A value in GeoJSON format.

Returns:

A value parsed from text in GeoJSON format.

parseWKT

public static GeographyPoint parseWKT(java.lang.String text)

See parseWKT(String, boolean).

Parameters:

text - Text parameter.

Returns:

(see linked method).

parseWKT

public static GeographyPoint parseWKT(java.lang.String text,
                                      boolean sridRequired)

Return a value parsed from OData WKT (well-known text) format.

See Also:

https://en.wikipedia.org/wiki/Well-known_text, OData ABNF.

Parameters:

text - A value in OData WKT format.

sridRequired - Is SRID prefix required?

Returns:

A value parsed from OData WKT (well-known text) format.

setCoordinates

public void setCoordinates(PointCoordinates value)

Set the coordinates of this value.

Parameters:

value - The coordinates of this value.

withLatitudeLongitude

public static GeographyPoint withLatitudeLongitude(double latitude,
                                                   double longitude)

Return 2D geography point.

Parameters:

latitude - Y-coordinate.

longitude - X-coordinate.

Returns:

2D geography point.

withXY

public static GeographyPoint withXY(double x,
                                    double y)

Return 2D geography point.

Parameters:

x - X-coordinate (longitude).

y - Y-coordinate (latitude).

Returns:

2D geography point.

withXYM

public static GeographyPoint withXYM(double x,
                                     double y,
                                     double m)

Return 2D geography point with measure.

Parameters:

x - X-coordinate (longitude).

y - Y-coordinate (latitude).

m - M-coordinate (measure).

Returns:

2D geography point with measure.

withXYZ

public static GeographyPoint withXYZ(double x,
                                     double y,
                                     double z)

Return 3D geography point.

Parameters:

x - X-coordinate (longitude).

y - Y-coordinate (latitude).

z - Z-coordinate (altitude).

Returns:

3D geography point.

withXYZM

public static GeographyPoint withXYZM(double x,
                                      double y,
                                      double z,
                                      double m)

Return 3D geography point with measure.

Parameters:

x - X-coordinate (longitude).

y - Y-coordinate (latitude).

z - Z-coordinate (altitude).

m - M-coordinate (measure).

Returns:

3D geography point with measure.