schemacrawler.schema

Interface ForeignKey

All Superinterfaces:

AttributedObject, BaseForeignKey<ForeignKeyColumnReference>, java.lang.Comparable<NamedObject>, Constraint, DefinedObject, DescribedObject, java.lang.Iterable<ForeignKeyColumnReference>, NamedObject, java.io.Serializable

public interface ForeignKey
extends BaseForeignKey<ForeignKeyColumnReference>, AttributedObject, DescribedObject, Constraint

Represents a foreign-key mapping to a primary key in another table.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
ForeignKeyDeferrability	getDeferrability() Gets the deferrability.
ForeignKeyUpdateRule	getDeleteRule() Gets the delete rule.
java.lang.String	getSpecificName() Gets a generated specific name for databases that support non-unique foreign key names.
ForeignKeyUpdateRule	getUpdateRule() Gets the update rule.

Methods inherited from interface schemacrawler.schema.BaseForeignKey

getColumnReferences

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks

Methods inherited from interface schemacrawler.schema.Constraint

getConstraintType, isDeferrable, isInitiallyDeferred

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getName, toUniqueLookupKey

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.DefinedObject

getDefinition, hasDefinition

Method Detail

getDeferrability

ForeignKeyDeferrability getDeferrability()

Gets the deferrability.

Returns:

Deferrability

getDeleteRule

ForeignKeyUpdateRule getDeleteRule()

Gets the delete rule.

Returns:

Delete rule

getSpecificName

java.lang.String getSpecificName()

Gets a generated specific name for databases that support non-unique foreign key names.

Returns:

Specific name of a foreign key

getUpdateRule

ForeignKeyUpdateRule getUpdateRule()

Gets the update rule.

Returns:

Update rule