ForeignKeyConstraint (SchemaSpy Maven Plugin 1.2.0 API)

java.lang.Object
- net.sourceforge.schemaspy.model.ForeignKeyConstraint

すべての実装されたインタフェース:

Comparable<ForeignKeyConstraint>

直系の既知のサブクラス:

ImpliedForeignKeyConstraint, RailsForeignKeyConstraint
```
public class ForeignKeyConstraint
extends Object
implements Comparable<ForeignKeyConstraint>
```
Represents a Foreign Key Constraint that "ties" a child table to a parent table via foreign and primary keys.

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`ForeignKeyConstraint(TableColumn parentColumn, TableColumn childColumn)` Same as `ForeignKeyConstraint(TableColumn, TableColumn, int, int)`, but defaults updateRule and deleteRule to `DatabaseMetaData.importedKeyNoAction`.
`ForeignKeyConstraint(TableColumn parentColumn, TableColumn childColumn, int updateRule, int deleteRule)` This constructor is intended for use after all of the tables have been found in the system.

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`compareTo(ForeignKeyConstraint other)` Custom comparison method to deal with foreign key names that aren't unique across all schemas being evaluated
`List<TableColumn>`	`getChildColumns()` Returns all of the foreign key columns that are referenced by this constraint.
`Table`	`getChildTable()` Returns the table on the "child" end of the relationship (contains the foreign key that references the parent table's primary key).
`int`	`getDeleteRule()` Returns the delete rule for this constraint.
`String`	`getDeleteRuleAlias()`
`String`	`getDeleteRuleDescription()`
`String`	`getDeleteRuleName()`
`String`	`getName()` Returns the name of the constraint
`List<TableColumn>`	`getParentColumns()` Returns all of the primary key columns that are referenced by this constraint.
`Table`	`getParentTable()` Returns the parent table (the table that contains the referenced primary key column).
`int`	`getUpdateRule()` Returns the update rule for this constraint.
`boolean`	`isCascadeOnDelete()` Returns `true` if this constraint should cascade deletions.
`boolean`	`isImplied()` Returns `true` if this is an implied constraint or `false` if it is "real".
`boolean`	`isNullOnDelete()` Returns `true` if the constraint indicates that the foreign key will be set to `null` when the parent key is deleted.
`boolean`	`isReal()` We have several types of constraints.
`boolean`	`isRestrictDelete()` Returns `true` if the constraint prevents the parent table from being deleted if child tables exist.
`String`	`toString()` Returns a string representation of this foreign key constraint.
`static String`	`toString(List<TableColumn> columns)` Static method that returns a string representation of the specified list of `columns`.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - ForeignKeyConstraint
```
public ForeignKeyConstraint(TableColumn parentColumn,
                            TableColumn childColumn,
                            int updateRule,
                            int deleteRule)
```
    This constructor is intended for use after all of the tables have been found in the system. One impact of using this constructor is that it will "glue" the two tables together through their columns.
    
    パラメータ:
    
    parentColumn -
    
    childColumn -
  - ForeignKeyConstraint
```
public ForeignKeyConstraint(TableColumn parentColumn,
                            TableColumn childColumn)
```
    Same as ForeignKeyConstraint(TableColumn, TableColumn, int, int), but defaults updateRule and deleteRule to DatabaseMetaData.importedKeyNoAction.
    
    パラメータ:
    
    parentColumn -
    
    childColumn -
- メソッドの詳細
  - getName
```
public String getName()
```
    Returns the name of the constraint
    
    戻り値:
  - getParentTable
```
public Table getParentTable()
```
    Returns the parent table (the table that contains the referenced primary key column).
    
    戻り値:
  - getParentColumns
```
public List<TableColumn> getParentColumns()
```
    Returns all of the primary key columns that are referenced by this constraint.
    
    戻り値:
  - getChildTable
```
public Table getChildTable()
```
    Returns the table on the "child" end of the relationship (contains the foreign key that references the parent table's primary key).
    
    戻り値:
  - getChildColumns
```
public List<TableColumn> getChildColumns()
```
    Returns all of the foreign key columns that are referenced by this constraint.
    
    戻り値:
  - getDeleteRule
```
public int getDeleteRule()
```
    Returns the delete rule for this constraint.
    
    関連項目:
    
    java.sql.DatabaseMetaData#importedKeyCascade}
  - isCascadeOnDelete
```
public boolean isCascadeOnDelete()
```
    Returns true if this constraint should cascade deletions.
    
    戻り値:
  - isRestrictDelete
```
public boolean isRestrictDelete()
```
    Returns true if the constraint prevents the parent table from being deleted if child tables exist.
    
    戻り値:
  - isNullOnDelete
```
public boolean isNullOnDelete()
```
    Returns true if the constraint indicates that the foreign key will be set to null when the parent key is deleted.
    
    戻り値:
  - getDeleteRuleName
```
public String getDeleteRuleName()
```
  - getDeleteRuleDescription
```
public String getDeleteRuleDescription()
```
  - getDeleteRuleAlias
```
public String getDeleteRuleAlias()
```
  - getUpdateRule
```
public int getUpdateRule()
```
    Returns the update rule for this constraint.
    
    関連項目:
    
    java.sql.DatabaseMetaData#importedKeyCascade}
  - isImplied
```
public boolean isImplied()
```
    Returns true if this is an implied constraint or false if it is "real". Subclasses that implement implied constraints should override this method.
    
    戻り値:
  - isReal
```
public boolean isReal()
```
    We have several types of constraints. This returns true if the constraint came from the database metadata and not inferred by something else. This is different than isImplied() in that implied relationships are a specific type of non-real relationships.
    
    戻り値:
  - compareTo
```
public int compareTo(ForeignKeyConstraint other)
```
    Custom comparison method to deal with foreign key names that aren't unique across all schemas being evaluated
    
    定義:
    
    compareTo インタフェース内 Comparable<ForeignKeyConstraint>
    
    パラメータ:
    
    other - ForeignKeyConstraint
    
    戻り値:
  - toString
```
public static String toString(List<TableColumn> columns)
```
    Static method that returns a string representation of the specified list of columns.
    
    パラメータ:
    
    columns -
    
    戻り値:
  - toString
```
public String toString()
```
    Returns a string representation of this foreign key constraint.
    
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:

クラス ForeignKeyConstraint

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ForeignKeyConstraint

ForeignKeyConstraint

メソッドの詳細

getName

getParentTable

getParentColumns

getChildTable

getChildColumns

getDeleteRule

isCascadeOnDelete

isRestrictDelete

isNullOnDelete

getDeleteRuleName

getDeleteRuleDescription

getDeleteRuleAlias

getUpdateRule

isImplied

isReal

compareTo

toString

toString