de.tif.jacob.core.definition
Interface IKey

All Superinterfaces:

INamedObjectDefinition

public interface IKey
extends INamedObjectDefinition

This interface represents an abstraction of data source table keys. Keys could be either of the following:

a primary key

a foreign key

an unique or non-unique index

Method Summary

boolean	contains(ITableField field) Convenient method to check whether the given table field is part of this key.
java.lang.String	getDBName() Returns the name of this table within the physical database.
java.lang.String	getName() Returns the name of this key.
ITableDefinition	getTableDefinition() Returns the corresponding table definition of this key.
java.util.List	getTableFields() Returns the list of table fields this key exists of.
KeyType	getType() Returns the type of this key.

Methods inherited from interface de.tif.jacob.core.definition.INamedObjectDefinition

getDescription, getProperty

Method Detail

getName

java.lang.String getName()

Returns the name of this key.

Specified by:

getName in interface INamedObjectDefinition

Returns:

the key name

getDBName

java.lang.String getDBName()

Returns the name of this table within the physical database.

Returns:

the database name.

getType

KeyType getType()

Returns the type of this key.

Returns:

the key type

getTableDefinition

ITableDefinition getTableDefinition()

Returns the corresponding table definition of this key.

Returns:

the table definition

getTableFields

java.util.List getTableFields()

Returns the list of table fields this key exists of.

Returns:

List of ITableField

contains

boolean contains(ITableField field)

Convenient method to check whether the given table field is part of this key.

Parameters:

field - the table field

Returns:

true if the given table field is a part of this key, otherwise false