be.SIRAPRISE.typeimplementations

Class UserDefinedTypeImplementation

java.lang.Object

be.SIRAPRISE.typeimplementations.AbstractTypeImplementation_V0105

be.SIRAPRISE.typeimplementations.AbstractJavaBackedTypeImplementation_V0105

be.SIRAPRISE.typeimplementations.UserDefinedTypeImplementation

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class UserDefinedTypeImplementation
extends AbstractJavaBackedTypeImplementation_V0105

A UserDefinedTypeImplementation is the object holding the implementation for any user-defined type. Note that this implementation, as it appears on the client side of things, may be incomplete, because any possrep constraint expression cannot possibly be represented on the client side, and therefore possrep constraints associated with the user-defined type cannot be evaluated in the valueFromxxx() methods.

Author:

Erwin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserDefinedTypeImplementation() 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 other constructor
UserDefinedTypeImplementation(NameIdentifier typeName, UDTPhysicalPossrepImplementation physicalPossrepImplementation, MyReadOnlySet<PossRepImplementation> nonPhysicalPossrepImplementations) Creates the UserDefinedTypeImplementation

Method Summary

Modifier and Type	Method and Description
PossRepImplementation	getDefaultPossrepImplementation() Gets the possrep implementation that is to be considered the default for the type.
int	getEncodingLength() Gets the fixed encoding length, if the type employs fixed-length encoding, i.e.
MyReadOnlySet<PossRepImplementation>	getPossrepImplementations() Gets the set of all PossRepImplementations for this type.
boolean	hasVariableLengthEncoding() Determines whether the number of bytes used in the physical encoding is the same for any possible value of the type.
void	readExternal(java.io.ObjectInput in)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class be.SIRAPRISE.typeimplementations.AbstractJavaBackedTypeImplementation_V0105

getEqualityOperatorImplementation, getOrderingOperatorImplementation, getPossrepImplementation, getRootTypeName, isOfType

Methods inherited from class be.SIRAPRISE.typeimplementations.AbstractTypeImplementation_V0105

getCommonScalarSuperTypeImplementation, getOrdinalOperatorImplementations, getTypeName, getTypeNameIdentifier, valueFromEscapedExternalRepresentation, valueFromEscapedExternalRepresentation, valueFromEscapedExternalRepresentationWithoutException

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedTypeImplementation

@Deprecated
public UserDefinedTypeImplementation()

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 other constructor

Creates the UserDefinedTypeImplementation without setting a type name

UserDefinedTypeImplementation

public UserDefinedTypeImplementation(NameIdentifier typeName,
                                     UDTPhysicalPossrepImplementation physicalPossrepImplementation,
                                     MyReadOnlySet<PossRepImplementation> nonPhysicalPossrepImplementations)

Creates the UserDefinedTypeImplementation

Parameters:

typeName - The name of the user-defined type

physicalPossrepImplementation - The physical possrep implementation for this type. This one will be used as the 'default' possrep.

nonPhysicalPossrepImplementations - The set of all the non-physical possreps for this type

Method Detail

getDefaultPossrepImplementation

public final PossRepImplementation getDefaultPossrepImplementation()

Description copied from class: AbstractTypeImplementation_V0105

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.

Specified by:

getDefaultPossrepImplementation in class AbstractTypeImplementation_V0105

Returns:

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

getEncodingLength

public int getEncodingLength()

Description copied from class: AbstractTypeImplementation_V0105

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.

Specified by:

getEncodingLength in class AbstractTypeImplementation_V0105

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.

hasVariableLengthEncoding

public final boolean hasVariableLengthEncoding()

Description copied from class: AbstractTypeImplementation_V0105

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.

Specified by:

hasVariableLengthEncoding in class AbstractTypeImplementation_V0105

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

getPossrepImplementations

public final MyReadOnlySet<PossRepImplementation> getPossrepImplementations()

Description copied from class: AbstractTypeImplementation_V0105

Gets the set of all PossRepImplementations for this type.

Specified by:

getPossrepImplementations in class AbstractTypeImplementation_V0105

Returns:

The set of all PossRepImplementations for this type.

readExternal

public final void readExternal(java.io.ObjectInput in)
                        throws java.io.IOException

Throws:

java.io.IOException

writeExternal

public final void writeExternal(java.io.ObjectOutput out)
                         throws java.io.IOException

Throws:

java.io.IOException