Top Description Fields Constructors Methods

org.hibernate.mapping

public Class ForeignKey

Class Inheritance

extends Constraint

java.lang.Object
org.hibernate.mapping.Constraint
org.hibernate.mapping.ForeignKey

Imports

java.util.ArrayList, .Iterator, .List, org.hibernate.MappingException, org.hibernate.dialect.Dialect

A foreign key constraint

Author: Gavin King

Field Summary

Modifier and Type	Field and Description
private boolean	cascadeDeleteEnabled
private List<E>	referencedColumns
private String	referencedEntityName
private Table	referencedTable

Constructor Summary

Access	Constructor and Description
public	ForeignKey()

Method Summary

Modifier and Type	Method and Description
private void	addReferencedColumn(Column column)
public void	addReferencedColumns(Iterator<E> referencedColumnsIterator)
public void	alignColumns() Validates that columnspan of the foreignkey and the primarykey is the same.
private void	alignColumns(Table referencedTable)
private void	appendColumns(StringBuffer buf, Iterator<E> columns)
public List<E>	getReferencedColumns() Returns the referenced columns if the foreignkey does not refer to the primary key
public String	getReferencedEntityName()
public Table	getReferencedTable()
public boolean	isCascadeDeleteEnabled()
public boolean	isPhysicalConstraint()
public boolean	isReferenceToPrimaryKey() Does this foreignkey reference the primary key of the reference table
public void	setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)
public void	setReferencedEntityName(String referencedEntityName)
public void	setReferencedTable(Table referencedTable)
public String	sqlConstraintString(Dialect dialect, String constraintName, String defaultCatalog, String defaultSchema) Implements abstract org.hibernate.mapping.Constraint.sqlConstraintString.
public String	sqlDropString(Dialect dialect, String defaultCatalog, String defaultSchema) Overrides org.hibernate.mapping.Constraint.sqlDropString. Implements org.hibernate.mapping.RelationalModel.sqlDropString.
public String	toString() Overrides org.hibernate.mapping.Constraint.toString. Returns a string representation of the object.

Inherited from org.hibernate.mapping.Constraint:: addColumn addColumns columnIterator containsColumn getColumn getColumnIterator getColumns getColumnSpan getName getTable isGenerated setName setTable sqlCreateString

Field Detail

cascadeDeleteEnabled	back to summary
private boolean cascadeDeleteEnabled

referencedColumns	back to summary
private List<E> referencedColumns

referencedEntityName	back to summary
private String referencedEntityName

referencedTable	back to summary
private Table referencedTable

Constructor Detail

ForeignKey	back to summary
public ForeignKey()

Method Detail

addReferencedColumn	back to summary
private void addReferencedColumn(Column column)

addReferencedColumns	back to summary
public void addReferencedColumns(Iterator<E> referencedColumnsIterator)

alignColumns	back to summary
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.

alignColumns	back to summary
private void alignColumns(Table referencedTable)

appendColumns	back to summary
private void appendColumns(StringBuffer buf, Iterator<E> columns)

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

getReferencedEntityName	back to summary
public String getReferencedEntityName()

getReferencedTable	back to summary
public Table getReferencedTable()

isCascadeDeleteEnabled	back to summary
public boolean isCascadeDeleteEnabled()

isPhysicalConstraint	back to summary
public boolean isPhysicalConstraint()

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

setCascadeDeleteEnabled	back to summary
public void setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)

setReferencedEntityName	back to summary
public void setReferencedEntityName(String referencedEntityName)

setReferencedTable	back to summary
public void setReferencedTable(Table referencedTable) throws MappingException

sqlConstraintString	back to summary
public String sqlConstraintString(Dialect dialect, String constraintName, String defaultCatalog, String defaultSchema) Implements abstract org.hibernate.mapping.Constraint.sqlConstraintString.

sqlDropString

back to summary

public String sqlDropString(Dialect dialect, String defaultCatalog, String defaultSchema)

Overrides org.hibernate.mapping.Constraint.sqlDropString.

Implements org.hibernate.mapping.RelationalModel.sqlDropString.

toString

back to summary

public String toString()

Overrides org.hibernate.mapping.Constraint.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.