com.sap.cloud.server.odata

Class GeographyValue

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.GeospatialValue

com.sap.cloud.server.odata.GeographyValue

Direct Known Subclasses:

GeographyCollection, GeographyLineString, GeographyMultiLineString, GeographyMultiPoint, GeographyMultiPolygon, GeographyPoint, GeographyPolygon

public abstract class GeographyValue
extends GeospatialValue

Abstract base class for geography data values.

See Also:

GeographyPoint, GeographyMultiPoint, GeographyLineString, GeographyMultiLineString, GeographyPolygon, GeographyMultiPolygon, GeographyCollection.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SRID Default Spatial Reference System Identifier for Geography Values (4326).

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

undefined

Constructor Summary

Constructors

Constructor and Description
GeographyValue()

Method Summary

Modifier and Type	Method and Description
static GeographyValue	castOptional(DataValue value) For internal use only.
static GeographyValue	castRequired(DataValue value) For internal use only.
java.lang.String	formatWKT() See formatWKT(boolean).
abstract java.lang.String	formatWKT(boolean sridRequired) Return this value formatted in OData WKT (well-known text) format.
int	getSrsCode() Return spatial Reference System Code, e.g.
java.lang.String	getSrsName() Return (nullable) Spatial Reference System Name (optional).
static GeographyValue	parseAny(java.lang.String text, DataType type) Parse a geography value from GeoJSON format.
static GeographyValue	parseAnyWKT(java.lang.String text) See parseAnyWKT(String, boolean).
static GeographyValue	parseAnyWKT(java.lang.String text, boolean sridRequired) Return a value parsed from OData WKT (well-known text) format.
void	setSrsCode(int value) Set spatial Reference System Code, e.g.
void	setSrsName(java.lang.String value) Set spatial Reference System Name (optional).
java.lang.String	toString() Convert this data value to a string.

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

cloneMutable, equals, getDataType, getTypeCode, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SRID

public static final int DEFAULT_SRID

Default Spatial Reference System Identifier for Geography Values (4326).

See Also:

Constant Field Values

Constructor Detail

GeographyValue

public GeographyValue()

Method Detail

castOptional

public static GeographyValue castOptional(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

castRequired

public static GeographyValue 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).

Returns:

(see linked method).

formatWKT

public abstract 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.

Parameters:

sridRequired - Is SRID prefix required?

Returns:

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

getSrsCode

public int getSrsCode()

Return spatial Reference System Code, e.g. EPSG SRID. Defaults to 4326.

Specified by:

getSrsCode in class GeospatialValue

Returns:

Spatial Reference System Code, e.g. EPSG SRID. Defaults to 4326.

getSrsName

public java.lang.String getSrsName()

Return (nullable) Spatial Reference System Name (optional).

Specified by:

getSrsName in class GeospatialValue

Returns:

(nullable) Spatial Reference System Name (optional).

parseAny

public static GeographyValue parseAny(java.lang.String text,
                                      DataType type)

Parse a geography value from GeoJSON format.

Parameters:

text - A value in GeoJSON format.

type - A DataType.isGeography.

Returns:

Geography value.

parseAnyWKT

public static GeographyValue parseAnyWKT(java.lang.String text)

See parseAnyWKT(String, boolean).

Parameters:

text - Text parameter.

Returns:

(see linked method).

parseAnyWKT

public static GeographyValue parseAnyWKT(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.

setSrsCode

public void setSrsCode(int value)

Set spatial Reference System Code, e.g. EPSG SRID. Defaults to 4326.

Specified by:

setSrsCode in class GeospatialValue

Parameters:

value - Spatial Reference System Code, e.g. EPSG SRID. Defaults to 4326.

setSrsName

public void setSrsName(java.lang.String value)

Set spatial Reference System Name (optional).

Specified by:

setSrsName in class GeospatialValue

Parameters:

value - Spatial Reference System Name (optional).

toString

public java.lang.String toString()

Convert this data value to a string. If the GeographyValue.dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

Specified by:

toString in class DataValue

Returns:

Lexical representation of this data value.