com.sap.cloud.server.odata

Class TypeFacets

java.lang.Object

com.sap.cloud.server.odata.TypeFacets

public class TypeFacets
extends java.lang.Object

Encapsulates the metadata of custom OData type facets.

See Also:

DataMethod, Parameter, Property, SimpleType,

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_LENGTH Indicates an unspecified length.
static int	ANY_PRECISION Indicates an unspecified precision.
static int	FLOATING_SCALE Indicates the scale is floating.
static int	VARIABLE_SCALE Indicates the scale is variable.
static int	VARIABLE_SRID Indicates the srid is variable.

Constructor Summary

Constructors

Constructor and Description
TypeFacets()

Method Summary

Modifier and Type	Method and Description
DataValue	getDefaultValue() Return (nullable) Default value for the associated definition.
java.lang.Integer	getMaxLength() Return (nullable) Maximum length of the associated value, or null for unspecified.
java.lang.Integer	getMinLength() Return (nullable) Minimum length of the associated value, or null for unspecified.
java.lang.Integer	getPrecision() Return (nullable) Precision of the associated value, or null for unspecified.
java.lang.Integer	getScale() Return (nullable) Scale of the associated value, or null, then it implies the value 0.
java.lang.Integer	getSrid() Return (nullable) EPSG Spatial Reference System Identifier (SRID) for the associated value, or null for unspecified.
java.lang.Boolean	isNullable() Return (nullable) Is the associated value nullable? If isNullable is null, then it implies the value true.
java.lang.Boolean	isUnicode() Return (nullable) Does the associated value permit Unicode characters? If isUnicode is null, then it implies the value true.
static TypeFacets	merge(TypeFacets from, TypeFacets to) For internal use only.
void	setDefaultValue(DataValue value) Set default value for the associated definition.
void	setMaxLength(java.lang.Integer value) Set maximum length of the associated value, or null for unspecified.
void	setMinLength(java.lang.Integer value) Set minimum length of the associated value, or null for unspecified.
void	setNullable(java.lang.Boolean value) Set is the associated value nullable? If isNullable is null, then it implies the value true.
void	setPrecision(java.lang.Integer value) Set precision of the associated value, or null for unspecified.
void	setScale(java.lang.Integer value) Set scale of the associated value, or null, then it implies the value 0.
void	setSrid(java.lang.Integer value) Set EPSG Spatial Reference System Identifier (SRID) for the associated value, or null for unspecified.
void	setUnicode(java.lang.Boolean value) Set does the associated value permit Unicode characters? If isUnicode is null, then it implies the value true.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_LENGTH

public static final int ANY_LENGTH

Indicates an unspecified length.

See Also:

Constant Field Values

ANY_PRECISION

public static final int ANY_PRECISION

Indicates an unspecified precision.

See Also:

Constant Field Values

FLOATING_SCALE

public static final int FLOATING_SCALE

Indicates the scale is floating.

See Also:

Constant Field Values

VARIABLE_SCALE

public static final int VARIABLE_SCALE

Indicates the scale is variable.

See Also:

Constant Field Values

VARIABLE_SRID

public static final int VARIABLE_SRID

Indicates the srid is variable.

See Also:

Constant Field Values

Constructor Detail

TypeFacets

public TypeFacets()

Method Detail

getDefaultValue

public DataValue getDefaultValue()

Return (nullable) Default value for the associated definition.

Returns:

(nullable) Default value for the associated definition.

getMaxLength

public java.lang.Integer getMaxLength()

Return (nullable) Maximum length of the associated value, or null for unspecified.

See Also:

ANY_LENGTH.

Returns:

(nullable) Maximum length of the associated value, or `null` for unspecified.

getMinLength

public java.lang.Integer getMinLength()

Return (nullable) Minimum length of the associated value, or null for unspecified.

See Also:

ANY_LENGTH.

Returns:

(nullable) Minimum length of the associated value, or `null` for unspecified.

getPrecision

public java.lang.Integer getPrecision()

Return (nullable) Precision of the associated value, or null for unspecified.

See Also:

ANY_PRECISION.

Returns:

(nullable) Precision of the associated value, or `null` for unspecified.

getScale

public java.lang.Integer getScale()

Return (nullable) Scale of the associated value, or null, then it implies the value 0.

See Also:

FLOATING_SCALE, VARIABLE_SCALE.

Returns:

(nullable) Scale of the associated value, or `null`, then it implies the value `0`.

getSrid

public java.lang.Integer getSrid()

Return (nullable) EPSG Spatial Reference System Identifier (SRID) for the associated value, or null for unspecified.

See Also:

VARIABLE_SRID.

Returns:

(nullable) [EPSG](http://www.epsg.org/Geodetic.html) Spatial Reference System Identifier (SRID) for the associated value, or `null` for unspecified.

isNullable

public java.lang.Boolean isNullable()

Return (nullable) Is the associated value nullable? If isNullable is null, then it implies the value true.

Returns:

(nullable) Is the associated value nullable?

isUnicode

public java.lang.Boolean isUnicode()

Return (nullable) Does the associated value permit Unicode characters? If isUnicode is null, then it implies the value true.

Returns:

(nullable) Does the associated value permit Unicode characters?

merge

public static TypeFacets merge(TypeFacets from,
                               TypeFacets to)

For internal use only.

Parameters:

from - (internal use only)

to - (internal use only)

Returns:

(internal use only)

setDefaultValue

public void setDefaultValue(DataValue value)

Set default value for the associated definition.

Parameters:

value - Default value for the associated definition.

setMaxLength

public void setMaxLength(java.lang.Integer value)

Set maximum length of the associated value, or null for unspecified.

See Also:

ANY_LENGTH.

Parameters:

value - Maximum length of the associated value, or `null` for unspecified.

setMinLength

public void setMinLength(java.lang.Integer value)

Set minimum length of the associated value, or null for unspecified.

See Also:

ANY_LENGTH.

Parameters:

value - Minimum length of the associated value, or `null` for unspecified.

setNullable

public void setNullable(java.lang.Boolean value)

Set is the associated value nullable? If isNullable is null, then it implies the value true.

Parameters:

value - Is the associated value nullable?

setPrecision

public void setPrecision(java.lang.Integer value)

Set precision of the associated value, or null for unspecified.

See Also:

ANY_PRECISION.

Parameters:

value - Precision of the associated value, or `null` for unspecified.

setScale

public void setScale(java.lang.Integer value)

Set scale of the associated value, or null, then it implies the value 0.

See Also:

FLOATING_SCALE, VARIABLE_SCALE.

Parameters:

value - Scale of the associated value, or `null`, then it implies the value `0`.

setSrid

public void setSrid(java.lang.Integer value)

Set EPSG Spatial Reference System Identifier (SRID) for the associated value, or null for unspecified.

See Also:

VARIABLE_SRID.

Parameters:

value - [EPSG](http://www.epsg.org/Geodetic.html) Spatial Reference System Identifier (SRID) for the associated value, or `null` for unspecified.

setUnicode

public void setUnicode(java.lang.Boolean value)

Set does the associated value permit Unicode characters? If isUnicode is null, then it implies the value true.

Parameters:

value - Does the associated value permit Unicode characters?