be.SIRAPRISE.typeimplementations

Class KeyDef

java.lang.Object

be.SIRAPRISE.typeimplementations.KeyDef

public class KeyDef
extends java.lang.Object

A KeyDef is a wrapper class encompassing a set of attribute names.

Author:

Erwin Smout

Constructor Summary

Constructors

Constructor and Description
KeyDef(java.util.Collection<NameIdentifier> attributeNames, boolean dummy) Creates the KeyDef
KeyDef(java.util.Collection<java.lang.String> attributeNames) Deprecated. - replace with KeyDef(Collection, boolean)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equalsKeyDef(KeyDef obj) Checks if this KeyDef is equal to the given one.
MyReadOnlySet<NameIdentifier>	getAttributeNameIdentifiers() Gets The names of the attributes that make up the key.
MyReadOnlySet<java.lang.String>	getAttributeNames() Deprecated. - replace with getAttributeNameIdentifiers()
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyDef

@Deprecated
public KeyDef(java.util.Collection<java.lang.String> attributeNames)

Deprecated. - replace with KeyDef(Collection, boolean)

Creates the key specification

Parameters:

attributeNames - The names of the attributes (as String objects - not as Value objects) that make up the key

KeyDef

public KeyDef(java.util.Collection<NameIdentifier> attributeNames,
              boolean dummy)

Creates the KeyDef

Parameters:

attributeNames - The names of the attributes

dummy - dummy unused parameter because java has no other way to distinguish constructors based on generics of the parameters

Method Detail

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsKeyDef

public final boolean equalsKeyDef(KeyDef obj)

Checks if this KeyDef is equal to the given one. Two KeyDefs are equal if and only if they represent the same set of attribute names.

Parameters:

obj - Another KeyDef to compare this one to.

Returns:

true if this KeyDef represents the same set of attributes as the given one.

getAttributeNames

@Deprecated
public final MyReadOnlySet<java.lang.String> getAttributeNames()

Deprecated. - replace with getAttributeNameIdentifiers()

Gets The names of the attributes that make up the key. The elements are guaranteed to constitute a set, even though the object returned is not itself a Set.

Returns:

The names of the attributes that make up the key

getAttributeNameIdentifiers

public final MyReadOnlySet<NameIdentifier> getAttributeNameIdentifiers()

Gets The names of the attributes that make up the key. The elements are guaranteed to constitute a set, even though the object returned is not itself a Set.

Returns:

The names of the attributes that make up the key

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object