ForeignKey (GemFire XD Java API Documentation)

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

All Implemented Interfaces:

Serializable
```
public class ForeignKey
extends Object
implements Serializable
```
Represents a database foreign key.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ForeignKey()
Creates a new foreign key object that has no name.

ForeignKey(String name)
Creates a new foreign key object.

Constructors
Constructor and Description
`ForeignKey()` Creates a new foreign key object that has no name.
`ForeignKey(String name)` Creates a new foreign key object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addReference(Reference reference)` Adds a reference, ie.
`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.
`CascadeActionEnum`	`getOnDelete()` Returns the action for this foreignkey for when the referenced row is deleted.
`CascadeActionEnum`	`getOnUpdate()` Returns the action for this foreignkey for when the referenced row is changed.
`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.
`boolean`	`hasForeignColumn(String columnName, boolean caseSensitive)` 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`	`hasLocalColumn(String columnName, boolean caseSensitive)` Determines whether this foreign key uses the indicated 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.
`void`	`setOnDelete(CascadeActionEnum onDelete)` Sets the action for this foreignkey for when the referenced row is deleted.
`void`	`setOnUpdate(CascadeActionEnum onUpdate)` Sets the action for this foreignkey for when the referenced row is changed.
`String`	`toString()`
`String`	`toVerboseString()` Returns a verbose string representation of this foreign key.

Methods inherited from class java.lang.Object
clone, 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
  - getOnDelete
```
public CascadeActionEnum getOnDelete()
```
    Returns the action for this foreignkey for when the referenced row is deleted.
    
    Returns:
    The action
  - setOnDelete
```
public void setOnDelete(CascadeActionEnum onDelete)
                 throws NullPointerException
```
    Sets the action for this foreignkey for when the referenced row is deleted.
    
    Parameters:
    onDelete - The action
    
    Throws:
    
    NullPointerException - If onDelete is null
  - getOnUpdate
```
public CascadeActionEnum getOnUpdate()
```
    Returns the action for this foreignkey for when the referenced row is changed.
    
    Returns:
    The action
  - setOnUpdate
```
public void setOnUpdate(CascadeActionEnum onUpdate)
                 throws NullPointerException
```
    Sets the action for this foreignkey for when the referenced row is changed.
    
    Parameters:
    onUpdate - The action
    
    Throws:
    
    NullPointerException - If onUdate is null
  - 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
  - hasLocalColumn
```
public boolean hasLocalColumn(Column column)
```
    Determines whether this foreign key uses the given column as a local column in a reference.
    
    Parameters:
    column - The column to check
    
    Returns:
    true if a reference uses the column as a local column
  - hasLocalColumn
```
public boolean hasLocalColumn(String columnName,
                     boolean caseSensitive)
```
    Determines whether this foreign key uses the indicated column as a local column in a reference. This method assumes that the caller checked already that the column is a column in the table owning this foreign key.
    
    Parameters:
    columnName - The name of the column to check
    caseSensitive - Whether case matters when checking for the column's name
    
    Returns:
    true if a reference uses the column as a local column
  - hasForeignColumn
```
public boolean hasForeignColumn(Column column)
```
    Determines whether this foreign key uses the given column as a foreign column in a reference.
    
    Parameters:
    column - The column to check
    
    Returns:
    true if a reference uses the column as a foreign column
  - hasForeignColumn
```
public boolean hasForeignColumn(String columnName,
                       boolean caseSensitive)
```
    Determines whether this foreign key uses the given column as a foreign column in a reference. This method assumes that the caller already checked whether this foreign key references the tale owning the indicate column.
    
    Parameters:
    columnName - The name of the column to check
    caseSensitive - Whether case matters when checking for the column's name
    
    Returns:
    true if a reference uses the column as a foreign column
  - isAutoIndexPresent
```
public boolean isAutoIndexPresent()
```
    Determines whether this foreign key has an auto-generated associated index. Note that this is a hint for the platform and has no relevancy to the model itself.
    
    Returns:
    true if an auto-generated index exists
  - setAutoIndexPresent
```
public void setAutoIndexPresent(boolean autoIndexPresent)
```
    Specifies whether this foreign key has an auto-generated associated index. Note that this is a hint set by the model reader and has no relevancy to the model itself.
    
    Parameters:
    autoIndexPresent - true if an auto-generated index exists
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(ForeignKey otherFk)
```
    Compares this foreign key to the given one while ignoring the case of identifiers.
    
    Parameters:
    otherFk - The other foreign key
    
    Returns:
    true if this foreign key is equal (ignoring case) to the given one
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toVerboseString
```
public String toVerboseString()
```
    Returns a verbose string representation of this foreign key.
    
    Returns:
    The string representation

Class ForeignKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForeignKey

ForeignKey

Method Detail

getName

setName

getForeignTable

setForeignTable

getForeignTableName

setForeignTableName

getOnDelete

setOnDelete

getOnUpdate

setOnUpdate

getReferenceCount

getReference

getReferences

getFirstReference

addReference

removeReference

removeReference

hasLocalColumn

hasLocalColumn

hasForeignColumn

hasForeignColumn

isAutoIndexPresent

setAutoIndexPresent

equals

equalsIgnoreCase

hashCode

toString

toVerboseString