Package com.esprow.oapi.repository

Interface OapiMappedDatatype

public interface OapiMappedDatatype

A datatype corresponding to various type systems.

The following attributes and references are supported:

• Extension
• Annotation
• Builtin
• Element
• Max Inclusive
• Min Inclusive
• Parameter
• Pattern
• Standard

Method Summary

Modifier and Type	Method	Description
OapiAnnotation	getAnnotation()	Returns all metadata on an element (documentation etc.).
String	getElement()	Returns a datatype of elements if this datatype is an array.
OapiExtension	getExtension()	Returns an XML snippet of a mapped datatype in the native schema belonging to its encoding standard.
String	getMaxInclusive()	Returns an inclusive upper bound of a valid value range.
String	getMinInclusive()	Returns an inclusive lower bound of a valid value range.
String	getParameter()	Returns a standard parameter string specifying the datatype.
String	getPattern()	Returns a regular expression defining a valid value pattern.
Object	getStandard()	Returns the type of the system to which the datatype is mapped.
boolean	isBuiltin()	Returns an indication whether this datatype is built-in.
void	setAnnotation(OapiAnnotation value)	Set all metadata on an element (documentation etc.).
void	setBuiltin(boolean value)	Set an indication whether this datatype is built-in.
void	setElement(String value)	Set a datatype of elements if this datatype is an array.
void	setExtension(OapiExtension value)	Set an XML snippet of a mapped datatype in the native schema belonging to its encoding standard.
void	setMaxInclusive(String value)	Set an inclusive upper bound of a valid value range.
void	setMinInclusive(String value)	Set an inclusive lower bound of a valid value range.
void	setParameter(String value)	Set a standard parameter string specifying the datatype.
void	setPattern(String value)	Set a regular expression defining a valid value pattern.
void	setStandard(Object value)	Set the type of the system to which the datatype is mapped.

Method Details

getExtension

OapiExtension getExtension()

Returns an XML snippet of a mapped datatype in the native schema belonging to its encoding standard.

Returns:

an XML snippet of a mapped datatype in the native schema belonging to its encoding standard

See Also:

• setExtension(OapiExtension)

setExtension

void setExtension(OapiExtension value)

Set an XML snippet of a mapped datatype in the native schema belonging to its encoding standard.

Parameters:

value - the new value of the 'Extension' containment reference.

See Also:

• getExtension()

getAnnotation

OapiAnnotation getAnnotation()

Returns all metadata on an element (documentation etc.).

Returns:

all metadata on an element (documentation etc.)

See Also:

• setAnnotation(OapiAnnotation)

setAnnotation

void setAnnotation(OapiAnnotation value)

Set all metadata on an element (documentation etc.).

Parameters:

value - the new value of the 'Annotation' containment reference.

See Also:

• getAnnotation()

isBuiltin

boolean isBuiltin()

Returns an indication whether this datatype is built-in.

Returns:

an indication whether this datatype is built-in

See Also:

• setBuiltin(boolean)

setBuiltin

void setBuiltin(boolean value)

Set an indication whether this datatype is built-in.

Parameters:

value - the new value of the 'Builtin' attribute.

See Also:

• isBuiltin()

getElement

String getElement()

Returns a datatype of elements if this datatype is an array.

Returns:

a datatype of elements if this datatype is an array

See Also:

• setElement(String)

setElement

void setElement(String value)

Set a datatype of elements if this datatype is an array.

Parameters:

value - the new value of the 'Element' attribute.

See Also:

• getElement()

getMaxInclusive

String getMaxInclusive()

Returns an inclusive upper bound of a valid value range.

Returns:

an inclusive upper bound of a valid value range

See Also:

• setMaxInclusive(String)

setMaxInclusive

void setMaxInclusive(String value)

Set an inclusive upper bound of a valid value range.

Parameters:

value - the new value of the 'Max Inclusive' attribute.

See Also:

• getMaxInclusive()

getMinInclusive

String getMinInclusive()

Returns an inclusive lower bound of a valid value range.

Returns:

an inclusive lower bound of a valid value range

See Also:

• setMinInclusive(String)

setMinInclusive

void setMinInclusive(String value)

Set an inclusive lower bound of a valid value range.

Parameters:

value - the new value of the 'Min Inclusive' attribute.

See Also:

• getMinInclusive()

getParameter

String getParameter()

Returns a standard parameter string specifying the datatype.

Returns:

a standard parameter string specifying the datatype

See Also:

• setParameter(String)

setParameter

void setParameter(String value)

Set a standard parameter string specifying the datatype.

Parameters:

value - the new value of the 'Parameter' attribute.

See Also:

• getParameter()

getPattern

String getPattern()

Returns a regular expression defining a valid value pattern.

Returns:

a regular expression defining a valid value pattern

See Also:

• setPattern(String)

setPattern

void setPattern(String value)

Set a regular expression defining a valid value pattern.

Parameters:

value - the new value of the 'Pattern' attribute.

See Also:

• getPattern()

getStandard

Object getStandard()

Returns the type of the system to which the datatype is mapped.

Returns:

the type of the system to which the datatype is mapped

See Also:

• setStandard(Object)

setStandard

void setStandard(Object value)

Set the type of the system to which the datatype is mapped.

Parameters:

value - the new value of the 'Standard' attribute.

See Also:

• getStandard()