be.SIRAPRISE.typeimplementations

Interface PossRepImplementation_V0105

All Superinterfaces:

PossRepImplementation

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_V0105
extends 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
ReadOnlyMap<NameIdentifier,TypeDeclaration>	getComponentIdentifierTypeDeclarationsMap() Gets a map of component names to corresponding type declarations.
ValueBuffer	getComponentValue(java.lang.String componentName, ValueBuffer valueBuffer, Heading nonScalarHeading) "Extracts" a possrep component value out of a value of the type.
MyReadOnlyMap<NameIdentifier,ValueBuffer>	getIdentifierComponentValues(ValueBuffer valueBuffer, Heading nonScalarHeading) Gets all the possrep component values for a given value of the type this possrep is for
ValueBuffer	valueFromIdentifierComponentValues(java.util.Map<NameIdentifier,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.
java.lang.String	valueToEscapedExternalRepresentationVerbose(ValueBuffer valueBuffer, Heading nonScalarHeading) Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e.
java.lang.String	valueToExternalRepresentationVerbose(ValueBuffer valueBuffer, Heading nonScalarHeading) Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e.

Methods inherited from interface be.SIRAPRISE.typeimplementations.PossRepImplementation

getComponentNameMap, getComponentTypeDeclarationsMap, getComponentValue, getComponentValue, getComponentValues, getPossrepName, valueFromComponentValues, valueFromExternalRepresentation, valueToEscapedExternalRepresentation, valueToExternalRepresentation

Method Detail

getComponentIdentifierTypeDeclarationsMap

ReadOnlyMap<NameIdentifier,TypeDeclaration> getComponentIdentifierTypeDeclarationsMap()

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,
                              ValueBuffer valueBuffer,
                              Heading nonScalarHeading)

"Extracts" a possrep component value out of a value of the type. This method supersedes the getComponentValue() method of the PossRepImplementation14 interface.

Parameters:

componentName - The possrep component Name

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

nonScalarHeading - The heading defining the nonScalar type that the value in the (nonscalar) valueBuffer is of.

Returns:

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

getIdentifierComponentValues

MyReadOnlyMap<NameIdentifier,ValueBuffer> getIdentifierComponentValues(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

valueFromIdentifierComponentValues

ValueBuffer valueFromIdentifierComponentValues(java.util.Map<NameIdentifier,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

valueToEscapedExternalRepresentationVerbose

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

Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e. the integer 1 is rendered as INT(1)). 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.

valueToExternalRepresentationVerbose

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

Converts a value in internal format to the appropriate textual representation of that value for this possrep, including the surrounding typename (i.e. the integer 1 is rendered as INT(1)).

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.