org.apache.ddlutils.model
Class ForeignKey

java.lang.Object
  org.apache.ddlutils.model.ForeignKey

All Implemented Interfaces:

Cloneable

public class ForeignKey

extends Object

implements Cloneable

Represents a database foreign key.

Version:

$Revision: 365443 $

Author:

Thomas Dudziak

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.
protected Object	clone()
boolean	equals(Object obj)
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.
int	hashCode()
void	removeReference(int idx) Removes the indicated reference.
void	removeReference(Reference reference) Removes the given reference.
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

ForeignKey

public ForeignKey()

Creates a new foreign key object that has no name.

ForeignKey

public ForeignKey(String name)

Creates a new foreign key object.

Parameters:

name - The name of the foreign key

Method Detail

getName

public String getName()

Returns the name of this foreign key.

Returns:

The name

setName

public void setName(String name)

Sets the name of this foreign key.

Parameters:

name - The name

getForeignTable

public Table getForeignTable()

Returns the foreign table.

Returns:

The foreign table

setForeignTable

public void setForeignTable(Table foreignTable)

Sets the foreign table.

Parameters:

foreignTable - The foreign table

getForeignTableName

public String getForeignTableName()

Returns the name of the foreign table.

Returns:

The table name

setForeignTableName

public void setForeignTableName(String foreignTableName)

Sets the name of the foreign table. Please note that you should not use this method when manually constructing or manipulating the database model. Rather utilize the setForeignTable(Table) method.

Parameters:

foreignTableName - The table name

getReferenceCount

public int getReferenceCount()

Returns the number of references.

Returns:

The number of references

getReference

public Reference getReference(int idx)

Returns the indicated reference.

Parameters:

idx - The index

Returns:

The reference

getReferences

public Reference[] getReferences()

Returns the references.

Returns:

The references

getFirstReference

public Reference getFirstReference()

Returns the first reference if it exists.

Returns:

The first reference

addReference

public void addReference(Reference reference)

Adds a reference, ie. a mapping between a local column (in the table that owns this foreign key) and a remote column.

Parameters:

reference - The reference to add

removeReference

public void removeReference(Reference reference)

Removes the given reference.

Parameters:

reference - The reference to remove

removeReference

public void removeReference(int idx)

Removes the indicated reference.

Parameters:

idx - The index of the reference to remove

clone

protected Object clone()
                throws CloneNotSupportedException

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

toString

public String toString()

toVerboseString

public String toVerboseString()

Returns a verbose string representation of this foreign key.

Returns:

The string representation