FKey ( Depeche-0.7.5 )

java.lang.Object
- net.aditsu.depeche.FKey

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MutableFKey
```
public class FKey
extends Object
implements Serializable
```
Details of a foreign key

Author:

aditsu

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`findFKColumn(String name)` Returns the index of the foreign key column with a given name, within this foreign key
`int`	`findPKColumn(String name)` Returns the index of the primary key column with a given name, within this foreign key
`int`	`getDeferrability()` Returns the deferrability setting of this foreign key
`KeyRule`	`getDeleteRule()` Returns the rule used to handle DELETE on a row referenced by this foreign key
`String`	`getFKColumn(int x)` Returns the name of the foreign key column with a given index, within this foreign key
`KeyInfo`	`getFKeyInfo()` Returns a KeyInfo object listing the foreign key columns within this foreign key
`Table`	`getFKTable()` Returns the foreign/child table
`String`	`getName()` Returns the name of this foreign key
`String`	`getPKColumn(int x)` Returns the name of the primary key column with a given index, within this foreign key
`KeyInfo`	`getPKeyInfo()` Returns a KeyInfo object listing the primary key columns within this foreign key
`Table`	`getPKTable()` Returns the primary/parent table
`KeyRule`	`getUpdateRule()` Returns the rule used to handle UPDATE on a row referenced by this foreign key
`boolean`	`isDeferrable()` Returns true if this foreign key is deferrable
`boolean`	`isInitiallyDeferred()` Returns true if this foreign key is deferrable and initially deferred
`int`	`size()` Returns the number of columns used by this foreign key
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getFKColumn
```
public String getFKColumn(int x)
```
    Returns the name of the foreign key column with a given index, within this foreign key
  - getPKColumn
```
public String getPKColumn(int x)
```
    Returns the name of the primary key column with a given index, within this foreign key
  - findFKColumn
```
public int findFKColumn(String name)
```
    Returns the index of the foreign key column with a given name, within this foreign key
  - findPKColumn
```
public int findPKColumn(String name)
```
    Returns the index of the primary key column with a given name, within this foreign key
  - size
```
public int size()
```
    Returns the number of columns used by this foreign key
  - getFKeyInfo
```
public KeyInfo getFKeyInfo()
```
    Returns a KeyInfo object listing the foreign key columns within this foreign key
  - getPKeyInfo
```
public KeyInfo getPKeyInfo()
```
    Returns a KeyInfo object listing the primary key columns within this foreign key
  - getPKTable
```
public Table getPKTable()
```
    Returns the primary/parent table
  - getFKTable
```
public Table getFKTable()
```
    Returns the foreign/child table
  - getName
```
public String getName()
```
    Returns the name of this foreign key
  - getUpdateRule
```
public KeyRule getUpdateRule()
```
    Returns the rule used to handle UPDATE on a row referenced by this foreign key
  - getDeleteRule
```
public KeyRule getDeleteRule()
```
    Returns the rule used to handle DELETE on a row referenced by this foreign key
  - getDeferrability
```
public int getDeferrability()
```
    Returns the deferrability setting of this foreign key
    
    See Also:
    DatabaseMetaData.importedKeyInitiallyDeferred, DatabaseMetaData.importedKeyInitiallyImmediate, DatabaseMetaData.importedKeyNotDeferrable
  - isDeferrable
```
public boolean isDeferrable()
```
    Returns true if this foreign key is deferrable
  - isInitiallyDeferred
```
public boolean isInitiallyDeferred()
```
    Returns true if this foreign key is deferrable and initially deferred

Class FKey

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toString

getFKColumn

getPKColumn

findFKColumn

findPKColumn

size

getFKeyInfo

getPKeyInfo

getPKTable

getFKTable

getName

getUpdateRule

getDeleteRule

getDeferrability

isDeferrable

isInitiallyDeferred