org.apache.olingo.commons.core.edm.primitivetype

Class AbstractGeospatialType<T extends Geospatial>

java.lang.Object

org.apache.olingo.commons.core.edm.primitivetype.SingletonPrimitiveType

org.apache.olingo.commons.core.edm.primitivetype.AbstractGeospatialType<T>

All Implemented Interfaces:

EdmNamed, EdmPrimitiveType, EdmType

Direct Known Subclasses:

EdmGeography, EdmGeographyCollection, EdmGeographyLineString, EdmGeographyMultiLineString, EdmGeographyMultiPoint, EdmGeographyMultiPolygon, EdmGeographyPoint, EdmGeographyPolygon, EdmGeometry, EdmGeometryCollection, EdmGeometryLineString, EdmGeometryMultiLineString, EdmGeometryMultiPoint, EdmGeometryMultiPolygon, EdmGeometryPoint, EdmGeometryPolygon

public abstract class AbstractGeospatialType<T extends Geospatial>
extends SingletonPrimitiveType

Field Summary

Fields

Modifier and Type	Field and Description
protected Geospatial.Dimension	dimension
protected Geospatial.Type	type
protected String	uriPrefix
protected String	uriSuffix

Fields inherited from class org.apache.olingo.commons.core.edm.primitivetype.SingletonPrimitiveType

name

Fields inherited from interface org.apache.olingo.commons.api.edm.EdmPrimitiveType

EDM_NAMESPACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGeospatialType(Class<T> reference, Geospatial.Dimension dimension, Geospatial.Type type)

Method Summary

Modifier and Type	Method and Description
String	fromUriLiteral(String literal) Converts URI literal representation to default literal representation.
Class<?>	getDefaultType() Returns the default Java type for this EDM primitive type as described in the documentation of EdmPrimitiveType.
FullQualifiedName	getFullQualifiedName()
protected abstract <T> T	internalValueOfString(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode, Class<T> returnType)
protected abstract <T> String	internalValueToString(T value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
boolean	isCompatible(EdmPrimitiveType primitiveType) Checks type compatibility.
protected GeospatialCollection	stringToCollection(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected LineString	stringToLineString(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected MultiLineString	stringToMultiLineString(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected MultiPoint	stringToMultiPoint(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected MultiPolygon	stringToMultiPolygon(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected Point	stringToPoint(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected Polygon	stringToPolygon(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
String	toString()
protected String	toString(GeospatialCollection collection, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected String	toString(LineString lineString, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected String	toString(MultiLineString multiLineString, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected String	toString(MultiPoint multiPoint, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected String	toString(MultiPolygon multiPolygon, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected String	toString(Point point, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
protected String	toString(Polygon polygon, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode)
String	toUriLiteral(String literal) Converts default literal representation to URI literal representation.
boolean	validate(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode) Validates literal value.
<T> T	valueOfString(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode, Class<T> returnType) Converts literal representation of value to system data type.
String	valueToString(Object value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode) Converts system data type to literal representation of value.

Methods inherited from class org.apache.olingo.commons.core.edm.primitivetype.SingletonPrimitiveType

equals, getKind, getName, getNamespace, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.olingo.commons.api.edm.EdmPrimitiveType

validateDecimals

Field Detail

dimension

protected final Geospatial.Dimension dimension

type

protected final Geospatial.Type type

uriPrefix

protected String uriPrefix

uriSuffix

protected String uriSuffix

Constructor Detail

AbstractGeospatialType

protected AbstractGeospatialType(Class<T> reference,
                                 Geospatial.Dimension dimension,
                                 Geospatial.Type type)

Method Detail

getDefaultType

public Class<?> getDefaultType()

Description copied from interface: EdmPrimitiveType

Returns the default Java type for this EDM primitive type as described in the documentation of EdmPrimitiveType.

Returns:

the default Java type

stringToPoint

protected Point stringToPoint(String value,
                              Boolean isNullable,
                              Integer maxLength,
                              Integer precision,
                              Integer scale,
                              Boolean isUnicode)
                       throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

stringToMultiPoint

protected MultiPoint stringToMultiPoint(String value,
                                        Boolean isNullable,
                                        Integer maxLength,
                                        Integer precision,
                                        Integer scale,
                                        Boolean isUnicode)
                                 throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

stringToLineString

protected LineString stringToLineString(String value,
                                        Boolean isNullable,
                                        Integer maxLength,
                                        Integer precision,
                                        Integer scale,
                                        Boolean isUnicode)
                                 throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

stringToMultiLineString

protected MultiLineString stringToMultiLineString(String value,
                                                  Boolean isNullable,
                                                  Integer maxLength,
                                                  Integer precision,
                                                  Integer scale,
                                                  Boolean isUnicode)
                                           throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

stringToPolygon

protected Polygon stringToPolygon(String value,
                                  Boolean isNullable,
                                  Integer maxLength,
                                  Integer precision,
                                  Integer scale,
                                  Boolean isUnicode)
                           throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

stringToMultiPolygon

protected MultiPolygon stringToMultiPolygon(String value,
                                            Boolean isNullable,
                                            Integer maxLength,
                                            Integer precision,
                                            Integer scale,
                                            Boolean isUnicode)
                                     throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

stringToCollection

protected GeospatialCollection stringToCollection(String value,
                                                  Boolean isNullable,
                                                  Integer maxLength,
                                                  Integer precision,
                                                  Integer scale,
                                                  Boolean isUnicode)
                                           throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(Point point,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(MultiPoint multiPoint,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(LineString lineString,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(MultiLineString multiLineString,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(Polygon polygon,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(MultiPolygon multiPolygon,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toString

protected String toString(GeospatialCollection collection,
                          Boolean isNullable,
                          Integer maxLength,
                          Integer precision,
                          Integer scale,
                          Boolean isUnicode)
                   throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

getFullQualifiedName

public FullQualifiedName getFullQualifiedName()

Specified by:

getFullQualifiedName in interface EdmType

Returns:

full qualified name

isCompatible

public boolean isCompatible(EdmPrimitiveType primitiveType)

Description copied from interface: EdmPrimitiveType

Checks type compatibility.

Specified by:

isCompatible in interface EdmPrimitiveType

Parameters:

primitiveType - the EdmPrimitiveType to be tested for compatibility

Returns:

true if the provided type is compatible to this type

validate

public boolean validate(String value,
                        Boolean isNullable,
                        Integer maxLength,
                        Integer precision,
                        Integer scale,
                        Boolean isUnicode)

Description copied from interface: EdmPrimitiveType

Validates literal value.

Specified by:

validate in interface EdmPrimitiveType

Parameters:

value - the literal value

isNullable - whether the null value is allowed

maxLength - the maximum length

precision - the precision

scale - the scale

isUnicode - whether non-ASCII characters are allowed (relevant only for Edm.String)

Returns:

true if the validation is successful

valueOfString

public final <T> T valueOfString(String value,
                                 Boolean isNullable,
                                 Integer maxLength,
                                 Integer precision,
                                 Integer scale,
                                 Boolean isUnicode,
                                 Class<T> returnType)
                          throws EdmPrimitiveTypeException

Description copied from interface: EdmPrimitiveType

Converts literal representation of value to system data type.

Specified by:

valueOfString in interface EdmPrimitiveType

Parameters:

value - the literal representation of value

isNullable - whether the null value is allowed

maxLength - the maximum length

precision - the precision

scale - the scale

isUnicode - whether non-ASCII characters are allowed (relevant only for Edm.String)

returnType - the class of the returned value; it must be one of the list in the documentation of EdmPrimitiveType

Returns:

the value as an instance of the class the parameter returnType indicates

Throws:

EdmPrimitiveTypeException

internalValueOfString

protected abstract <T> T internalValueOfString(String value,
                                               Boolean isNullable,
                                               Integer maxLength,
                                               Integer precision,
                                               Integer scale,
                                               Boolean isUnicode,
                                               Class<T> returnType)
                                        throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

valueToString

public final String valueToString(Object value,
                                  Boolean isNullable,
                                  Integer maxLength,
                                  Integer precision,
                                  Integer scale,
                                  Boolean isUnicode)
                           throws EdmPrimitiveTypeException

Description copied from interface: EdmPrimitiveType

Converts system data type to literal representation of value.

Returns null if value is null and null is an allowed value.

Specified by:

valueToString in interface EdmPrimitiveType

Parameters:

value - the Java value as Object; its type must be one of the list in the documentation of EdmPrimitiveType

isNullable - whether the null value is allowed

maxLength - the maximum length

precision - the precision

scale - the scale

isUnicode - whether non-ASCII characters are allowed (relevant only for Edm.String)

Returns:

literal representation as String

Throws:

EdmPrimitiveTypeException

internalValueToString

protected abstract <T> String internalValueToString(T value,
                                                    Boolean isNullable,
                                                    Integer maxLength,
                                                    Integer precision,
                                                    Integer scale,
                                                    Boolean isUnicode)
                                             throws EdmPrimitiveTypeException

Throws:

EdmPrimitiveTypeException

toUriLiteral

public String toUriLiteral(String literal)

Description copied from interface: EdmPrimitiveType

Converts default literal representation to URI literal representation.

Returns null if the literal is null. Does not perform any validation.

Specified by:

toUriLiteral in interface EdmPrimitiveType

Parameters:

literal - the literal in default representation

Returns:

URI literal representation as String

fromUriLiteral

public String fromUriLiteral(String literal)
                      throws EdmPrimitiveTypeException

Description copied from interface: EdmPrimitiveType

Converts URI literal representation to default literal representation.

Returns null if the literal is null. Checks the presence of a required prefix and of required surrounding quotation marks but does not perform any further validation.

Specified by:

fromUriLiteral in interface EdmPrimitiveType

Parameters:

literal - the literal in URI representation

Returns:

default literal representation as String

Throws:

EdmPrimitiveTypeException - if a required prefix or required surrounding quotation marks are missing

toString

public String toString()

Overrides:

toString in class Object