public interface ForeignKey extends ColumnSet
Interface of a foreign key.
Modifier and Type | Interface and Description |
---|---|
static interface |
ForeignKey.ColumnLink |
static class |
ForeignKey.Mode |
Modifier and Type | Method and Description |
---|---|
void |
addColumnLink(Column.Name pName,
Column.Name pReferencedName)
Adds a reference between the given columns.
|
void |
addColumnLink(Column pColumn,
Column pReferencedColumn)
Adds a reference between the given columns.
|
void |
addColumnLink(java.lang.String pName,
java.lang.String pReferencedName)
Adds a reference between the given columns.
|
java.util.Iterator |
getColumnLinks()
Returns all column references in the foreign key.
|
ForeignKey.Mode |
getOnDelete()
Returns the OnDelete mode.
|
ForeignKey.Mode |
getOnUpdate()
Returns the OnUpdate mode.
|
ColumnSet |
getReferencedColumns()
Returns the set of referenced columns.
|
Table |
getReferencedTable()
Returns the referenced table.
|
void |
setOnDelete(ForeignKey.Mode pMode)
Sets the OnDelete mode.
|
void |
setOnUpdate(ForeignKey.Mode pMode)
Sets the OnUpdate mode.
|
getColumns, getTable
Table getReferencedTable()
Returns the referenced table.
void setOnDelete(ForeignKey.Mode pMode)
Sets the OnDelete mode.
ForeignKey.Mode getOnDelete()
Returns the OnDelete mode.
void setOnUpdate(ForeignKey.Mode pMode)
Sets the OnUpdate mode.
ForeignKey.Mode getOnUpdate()
Returns the OnUpdate mode.
void addColumnLink(Column pColumn, Column pReferencedColumn)
Adds a reference between the given columns.
pColumn
- A column of the table, on which the foreign key is
definedpReferencedColumn
- A column of the referenced tablevoid addColumnLink(Column.Name pName, Column.Name pReferencedName)
Adds a reference between the given columns.
pName
- Column name of the table, on which the foreign
key is definedpReferencedName
- Column name of the referenced table.void addColumnLink(java.lang.String pName, java.lang.String pReferencedName)
Adds a reference between the given columns.
pName
- Column name of the table, on which the foreign
key is definedpReferencedName
- Column name of the referenced table.java.util.Iterator getColumnLinks()
Returns all column references in the foreign key. Any instance
returned by the Iterator
is an instance of
ForeignKey.ColumnLink
.
ColumnSet getReferencedColumns()
Returns the set of referenced columns.