com.sibvisions.rad.persist.jdbc
Class ForeignKey

java.lang.Object
  com.sibvisions.rad.persist.jdbc.ForeignKey

All Implemented Interfaces:

Cloneable

public class ForeignKey
extends Object
implements Cloneable

It stores all relevant information, like FK Columns, PK Columns, etc. of an Foreign Key.

Constructor Summary

ForeignKey(Name pPKTable, Name pPKCatalog, Name pPKSchema)
Construct a Select cache object.

Method Summary

ForeignKey	clone()
Name[]	getFKColumns() Returns the foreign key columns.
String	getFKName() Returns the foreign key name.
Name	getLinkReferenceColumn() Returns the foreign key column for the LinkReference.
Name	getPKCatalog() Returns the catalog of the primary key table.
Name[]	getPKColumns() Returns the primary key columns.
Name	getPKSchema() Returns the schema of the primary key table.
Name	getPKTable() Returns the primary key table.
boolean	isNullable() Returns if the foreign key is nullable.
void	setFKColumns(Name[] pFKColumns) Sets the foreign key columns.
void	setFKName(String pFKName) Sets the foreign key name.
void	setLinkReferenceColumn(Name pLinkReferenceColumn) Sets the foreign key column for the LinkReference.
void	setNullable(boolean pNullable) Sets if the foreign key is nullable.
void	setPKCatalog(Name pPKCatalog) Sets the primary key catalog name.
void	setPKColumns(Name[] pPKColumns) Sets the primary key columns.
void	setPKSchema(Name pPKSchema) Sets the primary key Schema name.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForeignKey

public ForeignKey(Name pPKTable,
                  Name pPKCatalog,
                  Name pPKSchema)

Construct a Select cache object.

Parameters:

pPKTable - The primary key table

pPKCatalog - The catalog of the primary key table

pPKSchema - The schema of the primary key table

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clone

public ForeignKey clone()

Overrides:

clone in class Object

getPKColumns

public Name[] getPKColumns()

Returns the primary key columns.

Returns:

the primary key columns

setPKColumns

public void setPKColumns(Name[] pPKColumns)

Sets the primary key columns.

Parameters:

pPKColumns - the primary key columns to set

getFKColumns

public Name[] getFKColumns()

Returns the foreign key columns.

Returns:

the foreign key columns.

setFKColumns

public void setFKColumns(Name[] pFKColumns)

Sets the foreign key columns.

Parameters:

pFKColumns - the foreign key columns to set

getPKTable

public Name getPKTable()

Returns the primary key table.

Returns:

the primary key table

getPKCatalog

public Name getPKCatalog()

Returns the catalog of the primary key table.

Returns:

the catalog of the primary key table

setPKCatalog

public void setPKCatalog(Name pPKCatalog)

Sets the primary key catalog name.

Parameters:

pPKCatalog - the primary key catalog name.

getPKSchema

public Name getPKSchema()

Returns the schema of the primary key table.

Returns:

the schema of the primary key table.

setPKSchema

public void setPKSchema(Name pPKSchema)

Sets the primary key Schema name.

Parameters:

pPKSchema - the primary key schema name to use.

getLinkReferenceColumn

public Name getLinkReferenceColumn()

Returns the foreign key column for the LinkReference.

Returns:

the foreign key column for the LinkReference.

setLinkReferenceColumn

public void setLinkReferenceColumn(Name pLinkReferenceColumn)

Sets the foreign key column for the LinkReference.

Parameters:

pLinkReferenceColumn - the foreign key column for the LinkReference to set

isNullable

public boolean isNullable()

Returns if the foreign key is nullable.

Returns:

if the foreign key is nullable.

setNullable

public void setNullable(boolean pNullable)

Sets if the foreign key is nullable.

Parameters:

pNullable - the bNullable to set

getFKName

public String getFKName()

Returns the foreign key name.

Returns:

the foreign key name.

setFKName

public void setFKName(String pFKName)

Sets the foreign key name.

Parameters:

pFKName - the foreign key name.