|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.torque.map.ForeignKeyMap
public class ForeignKeyMap
ForeignKeyMap is used to model a foreign key in a database.
Nested Class Summary | |
---|---|
static class |
ForeignKeyMap.ColumnPair
A pair of local and Foreign column. |
Constructor Summary | |
---|---|
ForeignKeyMap(TableMap table,
String foreignTableName)
Constructor. |
|
ForeignKeyMap(TableMap table,
TableMap foreignTable)
Constructor. |
Method Summary | |
---|---|
void |
addColumns(ForeignKeyMap.ColumnPair columnPair)
Adds a column pair to the foreign key. |
List<ForeignKeyMap.ColumnPair> |
getColumns()
Returns the column pairs. |
TableMap |
getForeignTable()
Returns the foreign table of the foreign key. |
String |
getForeignTableName()
Returns name of the foreign table of the foreign key. |
TableMap |
getTable()
Returns the local table of the foreign key. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ForeignKeyMap(TableMap table, TableMap foreignTable)
table
- the local table, not null.foreignTable
- the foreign table, not null.
NullPointerException
- if an argument is null.public ForeignKeyMap(TableMap table, String foreignTableName)
table
- the local table, not null.foreignTableName
- the name of the foreign table, not null.
NullPointerException
- if an argument is null.Method Detail |
---|
public void addColumns(ForeignKeyMap.ColumnPair columnPair)
columnPair
- the column pair to add, not null.public TableMap getTable()
public TableMap getForeignTable()
IllegalStateException
- if the foreign table map builder
was not yet built.public String getForeignTableName()
public List<ForeignKeyMap.ColumnPair> getColumns()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |