be.SIRAPRISE.typeimplementations

Class AbstractTypeImplementation_V0105

java.lang.Object

be.SIRAPRISE.typeimplementations.AbstractTypeImplementation_V0105

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

AbstractJavaBackedTypeImplementation_V0105, ConstrainedTypeImplementation

public abstract class AbstractTypeImplementation_V0105
extends java.lang.Object
implements java.io.Externalizable

An abstract TypeImplementation class. Implementers can extend this class to make this class' methods available in their own type implementations.

Author:

Erwin Smout

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractTypeImplementation_V0105() Deprecated. - This constructor is publicly available only for reasons to do with the Externalizable machinery. The preferred way of instantiating the class is through the one-arg constructor
AbstractTypeImplementation_V0105(NameIdentifier typeName) Creates the AbstractTypeImplementation_V0105
AbstractTypeImplementation_V0105(java.lang.String typeName) Creates the AbstractTypeImplementation_V0105

Method Summary

Modifier and Type	Method and Description
static AbstractTypeImplementation_V0105	getCommonScalarSuperTypeImplementation(ConstrainedTypeImplementation typeImplementation1, AbstractTypeImplementation_V0105 typeImplementation2) Gets the implementation object that implements the most specific supertype of the types of which the given implementation objects are the type implementation.
abstract PossRepImplementation	getDefaultPossrepImplementation() Gets the possrep implementation that is to be considered the default for the type.
abstract int	getEncodingLength() Gets the fixed encoding length, if the type employs fixed-length encoding, i.e.
abstract OperatorImplementation_V0104	getEqualityOperatorImplementation() Gets the implementation object for the equality operator pertaining to this type.
abstract OperatorImplementation_V0104	getOrderingOperatorImplementation() Gets the implementation object for the ordering operator (GT) pertaining to this type.
OrdinalOperatorImplementations	getOrdinalOperatorImplementations() Gets an object holding the four ordinal operator implementations defined for the type : FIRSTxxx(), PRIOR(xxx), NEXT(xxx), and LASTxxx()
abstract PossRepImplementation	getPossrepImplementation(java.lang.String componentName) Gets the PossrepImplementation object implementing the possrep of which the given component name names a component.
abstract MyReadOnlySet<PossRepImplementation>	getPossrepImplementations() Gets the set of all PossRepImplementations for this type.
abstract java.lang.String	getRootTypeName() Gets the name of the 'root' type that this type ultimately derives from (through specialization by constraint).
java.lang.String	getTypeName() Gets the type name (= invocation name for the value selector operator of this type)
NameIdentifier	getTypeNameIdentifier() Gets the type name (= invocation name for the value selector operator of this type)
abstract boolean	hasVariableLengthEncoding() Determines whether the number of bytes used in the physical encoding is the same for any possible value of the type.
abstract boolean	isOfType(AbstractTypeImplementation_V0105 type) Deprecated. - replace with TypeDeclaration.matchesExpectedTypeDeclaration. This method cannot properly handle subtype relationships between nonscalar types
static ValueBuffer	valueFromEscapedExternalRepresentation(AbstractTypeImplementation_V0105 typeImplementation, java.lang.String valueText, Heading nonScalarHeading) Utility method to obtain a value from an external representation of that value, given a type implementation, a Heading further defining the type if the type is nonscalar, and the external representation of the value.
ValueBuffer	valueFromEscapedExternalRepresentation(java.lang.String valueText, Heading nonScalarHeading) Gets the Value obejct holding the value of which s is the external representation
ValueBuffer	valueFromEscapedExternalRepresentationWithoutException(java.lang.String valueText, Heading nonScalarHeading) Gets the Value object holding the value of which s is the external representation

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

AbstractTypeImplementation_V0105

@Deprecated
public AbstractTypeImplementation_V0105()

Deprecated. - This constructor is publicly available only for reasons to do with the Externalizable machinery. The preferred way of instantiating the class is through the one-arg constructor

Creates the AbstractTypeImplementation_V0105 without setting the type name.

AbstractTypeImplementation_V0105

public AbstractTypeImplementation_V0105(NameIdentifier typeName)

Creates the AbstractTypeImplementation_V0105

Parameters:

typeName - The name of the type being implemented

AbstractTypeImplementation_V0105

public AbstractTypeImplementation_V0105(java.lang.String typeName)

Creates the AbstractTypeImplementation_V0105

Parameters:

typeName - The name of the type being implemented

Method Detail

getCommonScalarSuperTypeImplementation

public static AbstractTypeImplementation_V0105 getCommonScalarSuperTypeImplementation(ConstrainedTypeImplementation typeImplementation1,
                                                                                      AbstractTypeImplementation_V0105 typeImplementation2)
                                                                               throws NotFoundException

Gets the implementation object that implements the most specific supertype of the types of which the given implementation objects are the type implementation. Note that since scalar inheritance is possible only with ConstrainedTypes, one of the arguments is a ConstrainedTypeImplementation in particular.

Parameters:

typeImplementation1 - The ConstrainedTypeImplementation for which a common supertype with the other type is to be searched.

typeImplementation2 - The other type, the most specific common supertype with typeimplementation1 is to be searched.

Returns:

the implementation object that implements the most specific supertype of the types of which the given implementation objects are the type implementation.

Throws:

NotFoundException - If no common scalar supertype exists.

valueFromEscapedExternalRepresentation

public static ValueBuffer valueFromEscapedExternalRepresentation(AbstractTypeImplementation_V0105 typeImplementation,
                                                                 java.lang.String valueText,
                                                                 Heading nonScalarHeading)
                                                          throws InvalidValueException

Utility method to obtain a value from an external representation of that value, given a type implementation, a Heading further defining the type if the type is nonscalar, and the external representation of the value.

Parameters:

typeImplementation - The implementation of the type, some value of which the valueText argument is an external representation for

valueText - The external representation to be parsed

nonScalarHeading - The Heading further defining the type is the type is nonscalar

Returns:

A ValueBuffer holding the value represented in valueText, in internal format

Throws:

InvalidValueException - If valueText is not a valid external representation for any value of the given type

getDefaultPossrepImplementation

public abstract PossRepImplementation getDefaultPossrepImplementation()

Gets the possrep implementation that is to be considered the default for the type. If the type does not provide any possrep(implementation)s at all, then this method should return null, and this type will be treated as a singleton type.

Returns:

the possrep implementation that is to be considered the default for the type, or null if the type is a singleton.

getEncodingLength

public abstract int getEncodingLength()

Gets the fixed encoding length, if the type employs fixed-length encoding, i.e. if the hasVariableLengthEncoding() method returns 'false'. Types that employ variable-length encodings are required to return a negative value.

Returns:

the fixed encoding length, if the type employs fixed-length encoding, i.e. if the hasVariableLengthEncoding() method returns 'false'. Types that employ variable-length encodings are required to return a negative value.

getEqualityOperatorImplementation

public abstract OperatorImplementation_V0104 getEqualityOperatorImplementation()

Gets the implementation object for the equality operator pertaining to this type.

Returns:

the implementation object for the equality operator pertaining to this type.

getOrderingOperatorImplementation

public abstract OperatorImplementation_V0104 getOrderingOperatorImplementation()
                                                                        throws TypeIsNotOrderedException

Gets the implementation object for the ordering operator (GT) pertaining to this type.

Returns:

the implementation object for the ordering operator pertaining to this type. Null if there is no such operator.

Throws:

TypeIsNotOrderedException - If the type is not ordered

getOrdinalOperatorImplementations

public final OrdinalOperatorImplementations getOrdinalOperatorImplementations()
                                                                       throws TypeIsNotOrdinalException

Gets an object holding the four ordinal operator implementations defined for the type : FIRSTxxx(), PRIOR(xxx), NEXT(xxx), and LASTxxx()

Returns:

an object holding the four ordinal operator implementations defined for the type : FIRSTxxx(), PRIOR(xxx), NEXT(xxx), and LASTxxx(). Null if not all four ordinal operators have been defined. If some of them are defined but not all four, get the implementation objects for them individually through the OperatorImplementationsManager.

Throws:

TypeIsNotOrdinalException - if the type is not ordinal (i.e. if not all four operators previously mentioned have been defined

getPossrepImplementation

public abstract PossRepImplementation getPossrepImplementation(java.lang.String componentName)
                                                        throws NotFoundException

Gets the PossrepImplementation object implementing the possrep of which the given component name names a component. This method is introduced in version 1.3. The method is optional, but implementers are strongly encouraged to add this method to any implementing class they already have developed.

Parameters:

componentName - The name of a component of some possrep of this type (and for which the corresponding PossrepImplementation object is to be returned)

Returns:

The PossrepImplementation object implementing the possrep of which the given component name names a component

Throws:

NotFoundException - If the type does not have any possrep with a component of the given name

getPossrepImplementations

public abstract MyReadOnlySet<PossRepImplementation> getPossrepImplementations()

Gets the set of all PossRepImplementations for this type.

Returns:

The set of all PossRepImplementations for this type.

getRootTypeName

public abstract java.lang.String getRootTypeName()

Gets the name of the 'root' type that this type ultimately derives from (through specialization by constraint).

Returns:

the name of the 'root' type that this type ultimately derives from (through specialization by constraint).

getTypeName

public final java.lang.String getTypeName()

Gets the type name (= invocation name for the value selector operator of this type)

Returns:

the type name (= invocation name for the value selector operator of this type)

getTypeNameIdentifier

public final NameIdentifier getTypeNameIdentifier()

Gets the type name (= invocation name for the value selector operator of this type)

Returns:

the type name (= invocation name for the value selector operator of this type)

hasVariableLengthEncoding

public abstract boolean hasVariableLengthEncoding()

Determines whether the number of bytes used in the physical encoding is the same for any possible value of the type. E.g. an integer type can always use 4 or 8 bytes for the encodings of its values, a text type can use just the number of byte positions needed.

Returns:

true if the length (in bytes) of the physical space needed to hold an encoding of a value of this type, is the same for all values

isOfType

@Deprecated
public abstract boolean isOfType(AbstractTypeImplementation_V0105 type)

Deprecated. - replace with TypeDeclaration.matchesExpectedTypeDeclaration. This method cannot properly handle subtype relationships between nonscalar types

Checks whether this type is either the given type itself, or is a constrainedtype whose [ultimate] base type is the given type

Parameters:

type - The type for which it is to be tested whether this type is a "subtype" of it

Returns:

True if this type is the same as the given type, or if this type is a constrained type whose base type is the named type

valueFromEscapedExternalRepresentation

public final ValueBuffer valueFromEscapedExternalRepresentation(java.lang.String valueText,
                                                                Heading nonScalarHeading)
                                                         throws InvalidValueException

Gets the Value obejct holding the value of which s is the external representation

Parameters:

valueText - The external representation to be parsed

nonScalarHeading - The Heading further defining the type is the type is nonscalar

Returns:

A ValueBuffer holding the value represented in valueText, in internal format

Throws:

InvalidValueException - If valueText is not a valid external representation for any value of the given type

valueFromEscapedExternalRepresentationWithoutException

public final ValueBuffer valueFromEscapedExternalRepresentationWithoutException(java.lang.String valueText,
                                                                                Heading nonScalarHeading)

Gets the Value object holding the value of which s is the external representation

Parameters:

valueText - The external representation to be parsed

nonScalarHeading - The Heading further defining the type is the type is nonscalar

Returns:

A ValueBuffer holding the value represented in valueText, in internal format

Throws:

java.lang.IllegalArgumentException - If valueText is not a valid external representation for any value of the given type