Package org.hibernate.mapping

Class ForeignKey

java.lang.Object
org.hibernate.mapping.Constraint
org.hibernate.mapping.ForeignKey
All Implemented Interfaces:
Serializable, Exportable
public class ForeignKey extends Constraint
A mapping model object representing a foreign key constraint.
See Also:

  • Constructor Details

    • ForeignKey

      public ForeignKey(Table table)

    • ForeignKey

      @Deprecated(since="7") public ForeignKey()
      Deprecated.

  • Method Details

    • getExportIdentifier

      public String getExportIdentifier()
      Description copied from interface: Exportable
      Get a unique identifier to make sure we are not exporting the same database structure multiple times.
      Returns:
      The exporting identifier.

    • disableCreation

      public void disableCreation()

    • isCreationEnabled

      public boolean isCreationEnabled()

    • setName

      public void setName(String name)
      Overrides:
      setName in class Constraint

    • getReferencedTable

      public Table getReferencedTable()

    • setReferencedTable

      public void setReferencedTable(Table referencedTable) throws MappingException
      Throws:
      MappingException

    • alignColumns

      public void alignColumns()
      Validates that column span of the foreign key and the primary key is the same.

      Furthermore it aligns the length of the underlying tables columns.

    • getReferencedEntityName

      public String getReferencedEntityName()

    • setReferencedEntityName

      public void setReferencedEntityName(String referencedEntityName)

    • getKeyDefinition

      public String getKeyDefinition()

    • setKeyDefinition

      public void setKeyDefinition(String keyDefinition)

    • setOnDeleteAction

      public void setOnDeleteAction(OnDeleteAction onDeleteAction)

    • getOnDeleteAction

      public OnDeleteAction getOnDeleteAction()

    • isPhysicalConstraint

      public boolean isPhysicalConstraint()

    • getReferencedColumns

      public List<Column> getReferencedColumns()
      Returns the referenced columns if the foreignkey does not refer to the primary key

    • isReferenceToPrimaryKey

      public boolean isReferenceToPrimaryKey()
      Does this foreignkey reference the primary key of the reference table

    • addReferencedColumns

      public void addReferencedColumns(List<Column> referencedColumns)

    • toString

      public String toString()
      Overrides:
      toString in class Constraint

    • resolveReferencedClass

      @Internal public PersistentClass resolveReferencedClass(Metadata metadata)