|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ddlutils.model.ForeignKey
Represents a database foreign key.
Constructor Summary | |
ForeignKey()
Creates a new foreign key object that has no name. |
|
ForeignKey(String name)
Creates a new foreign key object. |
Method Summary | |
void |
addReference(Reference reference)
Adds a reference, ie. |
Object |
clone()
|
boolean |
equals(Object obj)
|
boolean |
equalsIgnoreCase(ForeignKey otherFk)
Compares this foreign key to the given one while ignoring the case of identifiers. |
Reference |
getFirstReference()
Returns the first reference if it exists. |
Table |
getForeignTable()
Returns the foreign table. |
String |
getForeignTableName()
Returns the name of the foreign table. |
String |
getName()
Returns the name of this foreign key. |
Reference |
getReference(int idx)
Returns the indicated reference. |
int |
getReferenceCount()
Returns the number of references. |
Reference[] |
getReferences()
Returns the references. |
boolean |
hasForeignColumn(Column column)
Determines whether this foreign key uses the given column as a foreign column in a reference. |
int |
hashCode()
|
boolean |
hasLocalColumn(Column column)
Determines whether this foreign key uses the given column as a local column in a reference. |
boolean |
isAutoIndexPresent()
Determines whether this foreign key has an auto-generated associated index. |
void |
removeReference(int idx)
Removes the indicated reference. |
void |
removeReference(Reference reference)
Removes the given reference. |
void |
setAutoIndexPresent(boolean autoIndexPresent)
Specifies whether this foreign key has an auto-generated associated index. |
void |
setForeignTable(Table foreignTable)
Sets the foreign table. |
void |
setForeignTableName(String foreignTableName)
Sets the name of the foreign table. |
void |
setName(String name)
Sets the name of this foreign key. |
String |
toString()
|
String |
toVerboseString()
Returns a verbose string representation of this foreign key. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ForeignKey()
public ForeignKey(String name)
name
- The name of the foreign keyMethod Detail |
public String getName()
public void setName(String name)
name
- The namepublic Table getForeignTable()
public void setForeignTable(Table foreignTable)
foreignTable
- The foreign tablepublic String getForeignTableName()
public void setForeignTableName(String foreignTableName)
setForeignTable(Table)
method.
foreignTableName
- The table namepublic int getReferenceCount()
public Reference getReference(int idx)
idx
- The index
public Reference[] getReferences()
public Reference getFirstReference()
public void addReference(Reference reference)
reference
- The reference to addpublic void removeReference(Reference reference)
reference
- The reference to removepublic void removeReference(int idx)
idx
- The index of the reference to removepublic boolean hasLocalColumn(Column column)
column
- The column to check
true
if a reference uses the column as a local
columnpublic boolean hasForeignColumn(Column column)
column
- The column to check
true
if a reference uses the column as a foreign
columnpublic boolean isAutoIndexPresent()
true
if an auto-generated index existspublic void setAutoIndexPresent(boolean autoIndexPresent)
autoIndexPresent
- true
if an auto-generated index existspublic Object clone() throws CloneNotSupportedException
CloneNotSupportedException
public boolean equals(Object obj)
public boolean equalsIgnoreCase(ForeignKey otherFk)
otherFk
- The other foreign key
true
if this foreign key is equal (ignoring case) to the given onepublic int hashCode()
public String toString()
public String toVerboseString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |