be.SIRAPRISE.typeimplementations

Class TypeDeclaration

java.lang.Object

be.SIRAPRISE.typeimplementations.TypeDeclaration

Direct Known Subclasses:

NonScalarTypeDeclaration, ScalarTypeDeclaration

public abstract class TypeDeclaration
extends java.lang.Object

An abstract class covering the two possible types of type declaration : scalar and nonscalar ones

Author:

Erwin

Field Summary

Fields

Modifier and Type	Field and Description
static TypeDeclaration	INT Utility constant usable for any type declaration object declaring a INT.
static TypeDeclaration	NAME Utility constant usable for any type declaration object declaring a NAME.
static TypeDeclaration	STRING Utility constant usable for any type declaration object declaring a STRING.

Method Summary

Modifier and Type	Method and Description
static TypeDeclaration	getCommonSubTypeDeclaration(TypeDeclaration t1, TypeDeclaration t2) Gets the least specific common subtype between the two types given
static TypeDeclaration	getCommonSuperTypeDeclaration(TypeDeclaration t1, TypeDeclaration t2) Gets the most specific common supertype between the two types given
static TypeDeclaration	getTypeDeclaration(Heading heading, NameIdentifier typeName) Factory method for obtaining TypeDeclaration objects
static TypeDeclaration	getTypeDeclaration(Heading heading, java.lang.String typeName) Deprecated. - replace with getTypeNameIdentifier()
java.lang.String	getTypeName() Gets The type name
NameIdentifier	getTypeNameIdentifier() Gets The type name
abstract ValueBuffer	getValueBuffer(java.nio.ByteBuffer attributeValueEncoding) Gets the appropriate (i.e.
abstract boolean	isIntervalTyped() Checks whether the declared scalar type is interval-typed.
static boolean	isNonScalarType(java.lang.String typeName) Checks whether the given type name indicates a NonScalar Type.
abstract boolean	isScalar() Checks whether the declared type is scalar
static boolean	isScalarType(java.lang.String typeName) Checks whether the given type name indicates a Scalar Type.
abstract boolean	matchesExpectedTypeDeclaration(TypeDeclaration expectedTypeDeclaration) Checks whether this type declaration "matches" the given expected type declaration, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

INT

public static final TypeDeclaration INT

Utility constant usable for any type declaration object declaring a INT.

NAME

public static final TypeDeclaration NAME

Utility constant usable for any type declaration object declaring a NAME.

STRING

public static final TypeDeclaration STRING

Utility constant usable for any type declaration object declaring a STRING.

Method Detail

getCommonSubTypeDeclaration

public static TypeDeclaration getCommonSubTypeDeclaration(TypeDeclaration t1,
                                                          TypeDeclaration t2)
                                                   throws NotFoundException

Gets the least specific common subtype between the two types given

Parameters:

t1 - type 1

t2 - type 2

Returns:

A TypeDeclaration object for the type that is the least specific common subtype of t1 and t2

Throws:

NotFoundException - If no such subtype exists

getCommonSuperTypeDeclaration

public static TypeDeclaration getCommonSuperTypeDeclaration(TypeDeclaration t1,
                                                            TypeDeclaration t2)
                                                     throws NotFoundException

Gets the most specific common supertype between the two types given

Parameters:

t1 - type 1

t2 - type 2

Returns:

a Declaration object for the most common supertype between the two type declarations given

Throws:

NotFoundException - if no such common supertype exists

getTypeDeclaration

public static TypeDeclaration getTypeDeclaration(Heading heading,
                                                 NameIdentifier typeName)

Factory method for obtaining TypeDeclaration objects

Parameters:

heading - The heading that further defines the type details for a nonscalar type. Required if the type is indeed nonscalar.

typeName - The name of the type

Returns:

The appropriate TypeDeclaration object for the named type, plus the given heading if the named type is nonscalar

getTypeDeclaration

@Deprecated
public static TypeDeclaration getTypeDeclaration(Heading heading,
                                                             java.lang.String typeName)

Deprecated. - replace with getTypeNameIdentifier()

Factory method for obtaining TypeDeclaration objects

Parameters:

heading - The heading that further defines the type details for a nonscalar type. Required if the type is indeed nonscalar.

typeName - The name of the type

Returns:

The appropriate TypeDeclaration object for the named type, plus the given heading if the named type is nonscalar

isNonScalarType

public static boolean isNonScalarType(java.lang.String typeName)

Checks whether the given type name indicates a NonScalar Type.

Parameters:

typeName - a type name

Returns:

true if the given type name indicates a NonScalar Type.

isScalarType

public static boolean isScalarType(java.lang.String typeName)

Checks whether the given type name indicates a Scalar Type.

Parameters:

typeName - a type name

Returns:

true if the given type name indicates a Scalar Type.

getTypeName

public final java.lang.String getTypeName()

Gets The type name

Returns:

Returns The type name

getTypeNameIdentifier

public final NameIdentifier getTypeNameIdentifier()

Gets The type name

Returns:

Returns The type name

getValueBuffer

public abstract ValueBuffer getValueBuffer(java.nio.ByteBuffer attributeValueEncoding)

Gets the appropriate (i.e. corresponding to this type declaration) ValueBuffer holding the given encoded value

Parameters:

attributeValueEncoding - an encoding of a value of this type

Returns:

the appropriate (i.e. corresponding to this type declaration) ValueBuffer holding the given encoded value

isIntervalTyped

public abstract boolean isIntervalTyped()

Checks whether the declared scalar type is interval-typed. The system reserves type names ending with 'INTERVAL' for interval types.

Returns:

true if the declared scalar type is interval-typed.

isScalar

public abstract boolean isScalar()

Checks whether the declared type is scalar

Returns:

true if the declared type is scalar

matchesExpectedTypeDeclaration

public abstract boolean matchesExpectedTypeDeclaration(TypeDeclaration expectedTypeDeclaration)

Checks whether this type declaration "matches" the given expected type declaration, i.e. checks whether this type declaration is for a subtype of the expected one

Parameters:

expectedTypeDeclaration - A type declaration that is expected to be a declaration for a supertype of this one

Returns:

true if the given expected type declaration declares a supertype of the type declared by this declaration