Package org.teiid.metadata

Class ForeignKey

java.lang.Object

org.teiid.metadata.AbstractMetadataRecord

org.teiid.metadata.ColumnSet<Table>

org.teiid.metadata.KeyRecord

org.teiid.metadata.ForeignKey

All Implemented Interfaces:

Serializable

public class ForeignKey
extends KeyRecord

ForeignKeyRecordImpl

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.teiid.metadata.KeyRecord

KeyRecord.Type

Nested classes/interfaces inherited from class org.teiid.metadata.AbstractMetadataRecord

AbstractMetadataRecord.DataModifiable, AbstractMetadataRecord.Modifiable

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOW_JOIN

Fields inherited from class org.teiid.metadata.AbstractMetadataRecord

NAME_DELIM_CHAR, RELATIONAL_PREFIX

Constructor Summary

Constructors

Constructor	Description
ForeignKey()

Method Summary

Modifier and Type	Method	Description
KeyRecord	getPrimaryKey()	Deprecated.
List<String>	getReferenceColumns()
KeyRecord	getReferenceKey()
String	getReferenceTableName()	WARNING prior to validation this method will return a potentially fully-qualified name after resolving it will return an unqualified name
String	getUniqueKeyID()
void	setPrimaryKey(KeyRecord primaryKey)	Deprecated.
void	setReferenceColumns(List<String> referenceColumns)
void	setReferenceKey(KeyRecord primaryKey)	Note: does not need to be directly called.
void	setReferenceTableName(String tableName)
void	setUniqueKeyID(String keyID)

Methods inherited from class org.teiid.metadata.KeyRecord

getType

Methods inherited from class org.teiid.metadata.ColumnSet

addColumn, getColumnByName, getColumns, getParent, removeColumn, setColumns, setParent

Methods inherited from class org.teiid.metadata.AbstractMetadataRecord

equals, getAnnotation, getCanonicalName, getFullName, getIdentifier, getIncomingObjects, getName, getNameInSource, getProperties, getProperty, getProperty, getSourceName, getSQLString, getSQLString, getUUID, hashCode, isUUIDSet, setAnnotation, setIncomingObjects, setName, setNameInSource, setProperties, setProperty, setUUID, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALLOW_JOIN

public static final String ALLOW_JOIN

See Also:

Constant Field Values

Constructor Detail

ForeignKey

public ForeignKey()

Method Detail

getUniqueKeyID

public String getUniqueKeyID()

setUniqueKeyID

public void setUniqueKeyID(String keyID)

Parameters:

keyID -

getPrimaryKey

public KeyRecord getPrimaryKey()

Deprecated.

Returns:

the primary key or unique key referenced by this foreign key

See Also:

getReferenceKey()

getReferenceKey

public KeyRecord getReferenceKey()

Returns:

the primary or unique key referenced by this foreign key

setReferenceKey

public void setReferenceKey(KeyRecord primaryKey)

Note: does not need to be directly called. The engine can resolve the referenced key if setReferenceColumns(List) and setReferenceTableName(String) are used.

Parameters:

primaryKey - the primary key or unique key referenced by this foreign key

setPrimaryKey

public void setPrimaryKey(KeyRecord primaryKey)

Deprecated.

Parameters:

primaryKey - the primary key or unique key referenced by this foreign key

See Also:

setReferenceKey(KeyRecord)

getReferenceTableName

public String getReferenceTableName()

WARNING prior to validation this method will return a potentially fully-qualified name after resolving it will return an unqualified name

Returns:

setReferenceTableName

public void setReferenceTableName(String tableName)

getReferenceColumns

public List<String> getReferenceColumns()

setReferenceColumns

public void setReferenceColumns(List<String> referenceColumns)