be.SIRAPRISE.typeimplementations

Interface PossRepImplementation

All Known Subinterfaces:

PossRepImplementation_V0105

All Known Implementing Classes:

DbmsAngleImplementation, DbmsAverageImplementation, DbmsBarImplementation, DbmsBigintImplementation, DbmsBitsImplementation, DbmsBooleanImplementation, DbmsCharImplementation, DbmsDateImplementation, DbmsDecimalImplementation, DbmsFilenameImplementation, DbmsFloatImplementation, DbmsFooImplementation, DbmsIntImplementation, DbmsLongImplementation, DbmsNameImplementation, DbmsRelationImplementation, DbmsScalednumberImplementation, DbmsScalednumberImplementation_MP, DbmsStringImplementation, DbmsTimeofdayImplementation, DbmsTupleImplementation, FromToPossrepImplementation, IntervalTypeImplementation, UDTPhysicalPossrepImplementation

public interface PossRepImplementation

Defines the methods that the implementation class for a SIRA_PRISE PossRep must provide. This interface replaces PossRepImplementation. The old getComponentValue() method, which took a ScalarValueBuffer specifically, is now superseded by a like-named method that can act on any ValueBuffer.

Author:

Erwin Smout

Method Summary

Modifier and Type	Method and Description
MyReadOnlyMap<java.lang.String,java.lang.String>	getComponentNameMap() Deprecated. - it is preferrable to upgrade implementations of this interface to PossRepImplementation_V0105 and use its PossRepImplementation_V0105.getComponentIdentifierTypeDeclarationsMap() method.
ReadOnlyMap<java.lang.String,TypeDeclaration>	getComponentTypeDeclarationsMap() Deprecated. - it is preferrable to upgrade implementations of this interface to PossRepImplementation_V0105 and use its PossRepImplementation_V0105.getComponentIdentifierTypeDeclarationsMap() method.
ValueBuffer	getComponentValue(java.lang.String componentName, ScalarValueBuffer valueBuffer) "Extracts" a possrep component value out of a value of the type
ValueBuffer	getComponentValue(java.lang.String componentName, ValueBuffer valueBuffer) "Extracts" a possrep component value out of a value of the type
MyReadOnlyMap<java.lang.String,ValueBuffer>	getComponentValues(ValueBuffer valueBuffer, Heading nonScalarHeading) Gets all the possrep component values for a given value of the type this possrep is for
java.lang.String	getPossrepName() Gets the possrep name
ValueBuffer	valueFromComponentValues(java.util.Map<java.lang.String,ValueBuffer> componentValueMap) Returns a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.
ValueBuffer	valueFromExternalRepresentation(java.lang.String value, Heading nonScalarHeading) Convert a value of this possrep's type to internal format.
java.lang.String	valueToEscapedExternalRepresentation(ValueBuffer valueBuffer, Heading nonScalarHeading) Converts a value in internal format to the appropriate textual representation of that value for this possrep.
java.lang.String	valueToExternalRepresentation(ValueBuffer valueBuffer, Heading nonScalarHeading) Converts a value in internal format to the appropriate textual representation of that value for this possrep.

Method Detail

getComponentNameMap

@Deprecated
MyReadOnlyMap<java.lang.String,java.lang.String> getComponentNameMap()

Deprecated. - it is preferrable to upgrade implementations of this interface to PossRepImplementation_V0105 and use its PossRepImplementation_V0105.getComponentIdentifierTypeDeclarationsMap() method.

Gets a map of component/type names. The keys in the map are the names of the components of this possrep. The values in the map are the typenames corresponding to (the values for) the named component. Since both the keys and the values in the map are all names, they must both be all uppercase. The map can be empty, if this is a possrep that does not consist of components.

Returns:

a map of component/type names.

getComponentTypeDeclarationsMap

@Deprecated
ReadOnlyMap<java.lang.String,TypeDeclaration> getComponentTypeDeclarationsMap()

Deprecated. - it is preferrable to upgrade implementations of this interface to PossRepImplementation_V0105 and use its PossRepImplementation_V0105.getComponentIdentifierTypeDeclarationsMap() method.

Gets a map of component names to corresponding type declarations. The keys in the map are the names of the components of this possrep. The values in the map are the type declaration objects corresponding to the named component. The map can be empty, if this is a possrep that does not consist of components.

Returns:

a map of component/type names.

getComponentValue

ValueBuffer getComponentValue(java.lang.String componentName,
                              ScalarValueBuffer valueBuffer)

"Extracts" a possrep component value out of a value of the type

Parameters:

componentName - The possrep component Name

valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted

Returns:

The value of the component in this possrep's representation of the given value

getComponentValue

ValueBuffer getComponentValue(java.lang.String componentName,
                              ValueBuffer valueBuffer)

"Extracts" a possrep component value out of a value of the type

Parameters:

componentName - The possrep component Name

valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted

Returns:

The value of the component in this possrep's representation of the given value

getComponentValues

MyReadOnlyMap<java.lang.String,ValueBuffer> getComponentValues(ValueBuffer valueBuffer,
                                                               Heading nonScalarHeading)

Gets all the possrep component values for a given value of the type this possrep is for

Parameters:

valueBuffer - The scalarValueBuffer holding the value of which the possrep's component's value is to be extracted

nonScalarHeading - The heading defining the specific nonScalar type, if the type is nonScalar and the value is a body value alone

Returns:

a mapping of all the possrep component values for a given value of the type this possrep is for

getPossrepName

java.lang.String getPossrepName()

Gets the possrep name

Returns:

The possrep name

valueFromComponentValues

ValueBuffer valueFromComponentValues(java.util.Map<java.lang.String,ValueBuffer> componentValueMap)
                              throws InvalidValueException

Returns a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.

Parameters:

componentValueMap - A Map holding component names and their corresponding values, held in a ValueBuffer.

Returns:

a ValueBuffer holding the value of the type that this PossRepImplementation is for, and that corresponds to the component values given in the componentValueMap argument.

Throws:

InvalidValueException - If the given mapping of component names to component values does not constitute a valid value for the type

valueFromExternalRepresentation

ValueBuffer valueFromExternalRepresentation(java.lang.String value,
                                            Heading nonScalarHeading)
                                     throws InvalidValueException

Convert a value of this possrep's type to internal format. The implementation is responsible for ensuring that the result is within bounds with the possrep's type's minimum or maximum logical size (and thus with the corresponding minimum and maximum physical encoding size). If the type is variable-length, then any length may be chosen for the ByteBuffer returned, as long as the encoding of the value fits within that byteBuffer length. If the encoding of a value takes less bytes than the chosen length, then the remaining bytes must be filled with null bytes (0x00). Failing to obey this rule will subvert certain checksum computations that are done internally by SIRA_PRISE, and thus cause it to possibly produce wrong results. Note that if a type is variable-length, then the first four bytes in the returned ScalarValueBuffer's ByteBuffer must hold the logical length of the value.

Parameters:

value - the value in external format.

nonScalarHeading - The heading defining the specific nonScalar type, if the type is nonScalar and the value is a body value alone

Returns:

the value in internal format.

Throws:

InvalidValueException - If the textual representation does not represent a value of the possrep's type.

valueToEscapedExternalRepresentation

java.lang.String valueToEscapedExternalRepresentation(ValueBuffer valueBuffer,
                                                      Heading nonScalarHeading)

Converts a value in internal format to the appropriate textual representation of that value for this possrep. In this method, all tokens of the SIRA_PRISE metalanguage must be output in 'escaped' format, i.e. each '(' character in the representation of the value must be represented as the string "\(", each ')' as a "\)" and each '\' as a "\\". Observe that this does NOT apply to the opening and closing parentheses that delimit the value of a component.

Parameters:

valueBuffer - The value in internal format.

nonScalarHeading - The heading defining the specific nonScalar type, if the type the value held in valueBuffer is of, is indeed nonScalar. Can be left null for scalar types, as they are not "defined" by a Heading.

Returns:

The string representation of the given value, for this possrep.

valueToExternalRepresentation

java.lang.String valueToExternalRepresentation(ValueBuffer valueBuffer,
                                               Heading nonScalarHeading)

Converts a value in internal format to the appropriate textual representation of that value for this possrep.

Parameters:

valueBuffer - The value in internal format.

nonScalarHeading - The heading defining the specific nonScalar type, if the type the value held in valueBuffer is of, is indeed nonScalar. Can be left null for scalar types, as they are not "defined" by a Heading.

Returns:

The string representation of the given value, for this possrep.