org.hibernate.mapping

Class ForeignKey

Implemented Interfaces:
RelationalModel, Serializable

public class ForeignKey
extends Constraint

A foreign key constraint
Author:
Gavin King

Method Summary

void
addReferencedColumns(Iterator referencedColumnsIterator)
void
alignColumns()
Validates that columnspan of the foreignkey and the primarykey is the same.
List
getReferencedColumns()
Returns the referenced columns if the foreignkey does not refer to the primary key
String
getReferencedEntityName()
Table
getReferencedTable()
boolean
isCascadeDeleteEnabled()
boolean
isPhysicalConstraint()
boolean
isReferenceToPrimaryKey()
Does this foreignkey reference the primary key of the reference table
void
setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)
void
setReferencedEntityName(String referencedEntityName)
void
setReferencedTable(Table referencedTable)
String
sqlConstraintString(Dialect dialect, String constraintName, String defaultCatalog, String defaultSchema)
String
sqlDropString(Dialect dialect, String defaultCatalog, String defaultSchema)
String
toString()

Methods inherited from class org.hibernate.mapping.Constraint

addColumn, addColumns, columnIterator, containsColumn, getColumn, getColumnIterator, getColumnSpan, getColumns, getName, getTable, isGenerated, setName, setTable, sqlConstraintString, sqlCreateString, sqlDropString, toString

Method Details

addReferencedColumns

public void addReferencedColumns(Iterator referencedColumnsIterator)

alignColumns

public void alignColumns()
Validates that columnspan of the foreignkey and the primarykey is the same. Furthermore it aligns the length of the underlying tables columns.
Parameters:

getReferencedColumns

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

getReferencedEntityName

public String getReferencedEntityName()

getReferencedTable

public Table getReferencedTable()

isCascadeDeleteEnabled

public boolean isCascadeDeleteEnabled()

isPhysicalConstraint

public boolean isPhysicalConstraint()

isReferenceToPrimaryKey

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

setCascadeDeleteEnabled

public void setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)

setReferencedEntityName

public void setReferencedEntityName(String referencedEntityName)

setReferencedTable

public void setReferencedTable(Table referencedTable)
            throws MappingException

sqlConstraintString

public String sqlConstraintString(Dialect dialect,
                                  String constraintName,
                                  String defaultCatalog,
                                  String defaultSchema)
Overrides:
sqlConstraintString in interface Constraint

sqlDropString

public String sqlDropString(Dialect dialect,
                            String defaultCatalog,
                            String defaultSchema)
Specified by:
sqlDropString in interface RelationalModel
Overrides:
sqlDropString in interface Constraint

toString

public String toString()
Overrides:
toString in interface Constraint