com.metamatrix.metadata.runtime.api
Interface Key

All Superinterfaces:

MetadataObject, java.io.Serializable

All Known Implementing Classes:

BasicKey

public interface Key
extends MetadataObject

Instances of this interface represent Keys for a Group. The values of a Key are analogous to a Primary Key, Unique Key or Foreign Key in a database.

Method Summary

java.lang.String	getAlias() Return the alias.
java.lang.String	getDescription() Return the description.
java.util.List	getElementIDs() Returns an ordered list of ElementID's this key is made of.
short	getKeyType() Return short indicating the type of key.
short	getMatchType() Return short indicating the type of reference key matching.
java.lang.String	getPath() Return the path to the key.
MetadataID	getReferencedKey()
boolean	isAccessPattern() Return boolean indicating if this is an access pattern.
boolean	isForeignKey() Return boolean indicating if this key is a foreign key.
boolean	isIndexed() Return boolean indicating if this key is indexed.
boolean	isPrimaryKey() Return boolean indicating if the key is the primary key.
boolean	isUniqueKey() Return boolean indicating if the key is a unique key.

Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject

clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString

Method Detail

getDescription

java.lang.String getDescription()

Return the description.

Returns:

String

getAlias

java.lang.String getAlias()

Return the alias.

Returns:

String alias

getElementIDs

java.util.List getElementIDs()

Returns an ordered list of ElementID's this key is made of.

Returns:

List of ElementID's that make up the key

isPrimaryKey

boolean isPrimaryKey()

Return boolean indicating if the key is the primary key.

Returns:

boolean

isForeignKey

boolean isForeignKey()

Return boolean indicating if this key is a foreign key.

Returns:

boolean

isUniqueKey

boolean isUniqueKey()

Return boolean indicating if the key is a unique key.

Returns:

boolean

isIndexed

boolean isIndexed()

Return boolean indicating if this key is indexed.

Returns:

boolean

isAccessPattern

boolean isAccessPattern()

Return boolean indicating if this is an access pattern.

Returns:

boolean

getKeyType

short getKeyType()

Return short indicating the type of key.

Returns:

short

See Also:

MetadataConstants.KEY_TYPES

getMatchType

short getMatchType()

Return short indicating the type of reference key matching.

Returns:

short

See Also:

MetadataConstants.MATCH_TYPES

getReferencedKey

MetadataID getReferencedKey()

getPath

java.lang.String getPath()

Return the path to the key.

Returns:

String