org.apache.olingo.commons.core.edm

Class EdmTypeDefinitionImpl

java.lang.Object

org.apache.olingo.commons.core.edm.AbstractEdmAnnotatable

org.apache.olingo.commons.core.edm.AbstractEdmNamed

org.apache.olingo.commons.core.edm.EdmTypeImpl

org.apache.olingo.commons.core.edm.EdmTypeDefinitionImpl

All Implemented Interfaces:

EdmAnnotatable, EdmNamed, EdmPrimitiveType, EdmType, EdmTypeDefinition

public class EdmTypeDefinitionImpl
extends EdmTypeImpl
implements EdmTypeDefinition

Field Summary

Fields inherited from class org.apache.olingo.commons.core.edm.EdmTypeImpl

kind, typeName

Fields inherited from class org.apache.olingo.commons.core.edm.AbstractEdmAnnotatable

edm

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

EDM_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
EdmTypeDefinitionImpl(Edm edm, FullQualifiedName typeDefinitionName, CsdlTypeDefinition typeDefinition)

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.
Integer	getMaxLength()
Integer	getPrecision()
Integer	getScale()
SRID	getSrid()
EdmPrimitiveType	getUnderlyingType()
boolean	isCompatible(EdmPrimitiveType primitiveType) Checks type compatibility.
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.EdmTypeImpl

getFullQualifiedName, getKind, getNamespace

Methods inherited from class org.apache.olingo.commons.core.edm.AbstractEdmNamed

getName, toString

Methods inherited from class org.apache.olingo.commons.core.edm.AbstractEdmAnnotatable

getAnnotation, getAnnotations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

validateDecimals

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

getFullQualifiedName, getKind, getNamespace

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

getName

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

getAnnotation, getAnnotations

Constructor Detail

EdmTypeDefinitionImpl

public EdmTypeDefinitionImpl(Edm edm,
                             FullQualifiedName typeDefinitionName,
                             CsdlTypeDefinition typeDefinition)

Method Detail

getUnderlyingType

public EdmPrimitiveType getUnderlyingType()

Specified by:

getUnderlyingType in interface EdmTypeDefinition

Returns:

EdmPrimitiveType this type definition is based upon

getMaxLength

public Integer getMaxLength()

Specified by:

getMaxLength in interface EdmTypeDefinition

Returns:

the maximum length as an Integer or null if not specified

getPrecision

public Integer getPrecision()

Specified by:

getPrecision in interface EdmTypeDefinition

Returns:

the precision as an Integer or null if not specified

getScale

public Integer getScale()

Specified by:

getScale in interface EdmTypeDefinition

Returns:

the scale as an Integer or null if not specified

getSrid

public SRID getSrid()

Specified by:

getSrid in interface EdmTypeDefinition

Returns:

a non-negative integer or the special value variable

isUnicode

public Boolean isUnicode()

Specified by:

isUnicode in interface EdmTypeDefinition

Returns:

true if unicode or null if not specified

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

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.

Specified by:

getDefaultType in interface EdmPrimitiveType

Returns:

the default Java 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 <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

valueToString

public 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

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