be.SIRAPRISE.typeimplementations

Class NonScalarTypeDeclaration

java.lang.Object

be.SIRAPRISE.typeimplementations.TypeDeclaration

be.SIRAPRISE.typeimplementations.NonScalarTypeDeclaration

public final class NonScalarTypeDeclaration
extends TypeDeclaration

A NonScalarTypeDeclaration is a TypeDeclaration that accompanies the name of an attribute in a Heading if that attribute is relation-typed or tuple-typed.

Author:

Erwin Smout

Field Summary

Fields inherited from class be.SIRAPRISE.typeimplementations.TypeDeclaration

INT, NAME, STRING

Constructor Summary

Constructors

Constructor and Description
NonScalarTypeDeclaration(Heading heading, NameIdentifier typeName) Creates the typedeclaration
NonScalarTypeDeclaration(Heading heading, NameIdentifier typeName, java.util.Collection<KeyDef> keySpecifications, java.lang.String relationPredicate) Creates the NonScalarTypeDeclaration
NonScalarTypeDeclaration(Heading heading, java.lang.String typeName) Deprecated. deprecated
NonScalarTypeDeclaration(Heading heading, java.lang.String typeName, java.util.Collection<KeyDef> keySpecifications, java.lang.String relationPredicate) Deprecated. deprecated

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equalsNonScalarTypeDeclaration(NonScalarTypeDeclaration obj) Compares this NonScalarTypeDeclaration to another one for equality.
static TypeDeclaration	getCommonNonScalarSubTypeDeclaration(NonScalarTypeDeclaration t1, NonScalarTypeDeclaration t2) Gets the type declaration that is the declaration for the type that is the least specific subtype for both types given
static TypeDeclaration	getCommonNonScalarSuperTypeDeclaration(NonScalarTypeDeclaration t1, NonScalarTypeDeclaration t2) Gets the type declaration that is the declaration for the type that is the most specific supertype for both types given
Heading	getHeading() Gets the heading defining the concerned nonscalar type
java.util.Collection<KeyDef>	getKeySpecifications() Gets keySpecifications
java.lang.String	getRelationPredicate() Gets The predicate corresponding to the nonscalar value held in the container that this typedeclaration is for
NonScalarValueBuffer	getValueBuffer(java.nio.ByteBuffer attributeValueEncoding) Gets the appropriate (i.e.
int	hashCode()
boolean	isIntervalTyped() Checks whether the declared scalar type is interval-typed.
boolean	isScalar() Checks whether the declared type is scalar
boolean	matchesExpectedTypeDeclaration(TypeDeclaration expectedTypeDeclaration) Checks whether this type declaration "matches" the given expected type declaration, i.e.
java.lang.String	toString()

Methods inherited from class be.SIRAPRISE.typeimplementations.TypeDeclaration

getCommonSubTypeDeclaration, getCommonSuperTypeDeclaration, getTypeDeclaration, getTypeDeclaration, getTypeName, getTypeNameIdentifier, isNonScalarType, isScalarType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NonScalarTypeDeclaration

public NonScalarTypeDeclaration(Heading heading,
                                NameIdentifier typeName)

Creates the typedeclaration

Parameters:

heading - The heading defining the details of the nonscalar type the declaration si for

typeName - The name of the nonscalar type that the declaration is for

NonScalarTypeDeclaration

public NonScalarTypeDeclaration(Heading heading,
                                NameIdentifier typeName,
                                java.util.Collection<KeyDef> keySpecifications,
                                java.lang.String relationPredicate)

Creates the NonScalarTypeDeclaration

Parameters:

heading - The heading defining the details of the nonscalar type the declaration si for

typeName - The name of the nonscalar type that the declaration is for

keySpecifications - The set of key specifications that relations corresponding to this type declaration are known to satisfy. Only maintained for RELATION type declarations

relationPredicate - The predicate corresponding to the nonscalar value held in the container that this typedeclaration is for

NonScalarTypeDeclaration

@Deprecated
public NonScalarTypeDeclaration(Heading heading,
                                            java.lang.String typeName)

Deprecated. deprecated

Creates the typedeclaration

Parameters:

heading - The heading defining the details of the nonscalar type the declaration si for

typeName - The name of the nonscalar type that the declaration is for

NonScalarTypeDeclaration

@Deprecated
public NonScalarTypeDeclaration(Heading heading,
                                            java.lang.String typeName,
                                            java.util.Collection<KeyDef> keySpecifications,
                                            java.lang.String relationPredicate)

Deprecated. deprecated

Creates the NonScalarTypeDeclaration

Parameters:

heading - The heading defining the details of the nonscalar type the declaration si for

typeName - The name of the nonscalar type that the declaration is for

keySpecifications - The set of key specifications that relations corresponding to this type declaration are known to satisfy. Only maintained for RELATION type declarations

relationPredicate - The predicate corresponding to the nonscalar value held in the container that this typedeclaration is for

Method Detail

getCommonNonScalarSubTypeDeclaration

public static TypeDeclaration getCommonNonScalarSubTypeDeclaration(NonScalarTypeDeclaration t1,
                                                                   NonScalarTypeDeclaration t2)
                                                            throws NotFoundException

Gets the type declaration that is the declaration for the type that is the least specific subtype for both types given

Parameters:

t1 - type 1

t2 - type 2

Returns:

the type declaration that is the declaration for the type that is the least specific subtype for both types given

Throws:

NotFoundException - If no such supertype exists.

getCommonNonScalarSuperTypeDeclaration

public static TypeDeclaration getCommonNonScalarSuperTypeDeclaration(NonScalarTypeDeclaration t1,
                                                                     NonScalarTypeDeclaration t2)
                                                              throws NotFoundException

Gets the type declaration that is the declaration for the type that is the most specific supertype for both types given

Parameters:

t1 - type 1

t2 - type 2

Returns:

the type declaration that is the declaration for the type that is the most specific supertype for both types given

Throws:

NotFoundException - If no such supertype exists. This is the case if one type is a relation type and the other is a tuple type, or if the involved headings' attribute name sets are unequal, or if an attribute in the involved headings is of respective types that do not have a common supertype.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsNonScalarTypeDeclaration

public boolean equalsNonScalarTypeDeclaration(NonScalarTypeDeclaration obj)

Compares this NonScalarTypeDeclaration to another one for equality. A NonScalarTypeDeclaration is equal to another one if and only if both the type names and the Headings are equal to one another.

Parameters:

obj - Another NonScalarTypeDeclaration to compare this one to for equality

Returns:

true if this NonScalarTypeDeclaration is the same type and the same Heading as the other one, false otherwise.

getHeading

public final Heading getHeading()

Gets the heading defining the concerned nonscalar type

Returns:

the heading defining the concerned nonscalar type

getKeySpecifications

public final java.util.Collection<KeyDef> getKeySpecifications()

Gets keySpecifications

Returns:

keySpecifications.

getRelationPredicate

public final java.lang.String getRelationPredicate()

Gets The predicate corresponding to the nonscalar value held in the container that this typedeclaration is for

Returns:

The predicate corresponding to the nonscalar value held in the container that this typedeclaration is for

getValueBuffer

public NonScalarValueBuffer getValueBuffer(java.nio.ByteBuffer attributeValueEncoding)

Description copied from class: TypeDeclaration

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

Specified by:

getValueBuffer in class TypeDeclaration

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isIntervalTyped

public boolean isIntervalTyped()

Description copied from class: TypeDeclaration

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

Specified by:

isIntervalTyped in class TypeDeclaration

Returns:

true if the declared scalar type is interval-typed.

isScalar

public final boolean isScalar()

Description copied from class: TypeDeclaration

Checks whether the declared type is scalar

Specified by:

isScalar in class TypeDeclaration

Returns:

true if the declared type is scalar

matchesExpectedTypeDeclaration

public boolean matchesExpectedTypeDeclaration(TypeDeclaration expectedTypeDeclaration)

Description copied from class: TypeDeclaration

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

Specified by:

matchesExpectedTypeDeclaration in class TypeDeclaration

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object