Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.mapping.ForeignKey

Modifier and Type	Field and Description
private boolean	cascadeDeleteEnabled
private boolean	creationEnabled
private String	keyDefinition
private List<Column>	referencedColumns
private String	referencedEntityName
private Table	referencedTable Deprecated as a consequence of `Table` being deprecated.

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 column span of the foreign key and the primary key is the same.
private void	alignColumns(Table referencedTable) Deprecated as a consequence of `Table` being deprecated.
private void	appendColumns(StringBuilder buf, Iterator<E> columns)
public void	disableCreation()
public String	generatedConstraintNamePrefix() Implements abstract org.hibernate.mapping.Constraint.generatedConstraintNamePrefix.
public String	getExportIdentifier() Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier. Get a unique identifier to make sure we are not exporting the same database structure multiple times.
public String	getKeyDefinition()
public List<E>	getReferencedColumns() Returns the referenced columns if the foreignkey does not refer to the primary key
public String	getReferencedEntityName()
public Table	getReferencedTable() Deprecated as a consequence of `Table` being deprecated.
public boolean	isCascadeDeleteEnabled()
public boolean	isCreationEnabled()
public boolean	isPhysicalConstraint()
public boolean	isReferenceToPrimaryKey() Does this foreignkey reference the primary key of the reference table
public void	setCascadeDeleteEnabled(boolean cascadeDeleteEnabled)
public void	setKeyDefinition(String keyDefinition)
public void	setName(String name) Overrides org.hibernate.mapping.Constraint.setName.
public void	setReferencedEntityName(String referencedEntityName)
public void	setReferencedTable(Table referencedTable) Deprecated as a consequence of `Table` being deprecated.
public String	sqlConstraintString(SqlStringGenerationContext context, String constraintName, String defaultCatalog, String defaultSchema) Implements abstract org.hibernate.mapping.Constraint.sqlConstraintString.
public String	sqlDropString(SqlStringGenerationContext context, 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 generateName generateName getColumn getColumnIterator getColumns getColumnSpan getName getTable hashedName isGenerated setTable sqlCreateString

cascadeDeleteEnabled	back to summary
private boolean cascadeDeleteEnabled

creationEnabled	back to summary
private boolean creationEnabled

keyDefinition	back to summary
private String keyDefinition

referencedColumns	back to summary
private List<Column> referencedColumns

referencedEntityName	back to summary
private String referencedEntityName

referencedTable	back to summary
private Table referencedTable Deprecated as a consequence of `Table` being deprecated. See corresponding docs for further information.

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 column span of the foreign key and the primary key is the same. Furthermore it aligns the length of the underlying tables columns.

alignColumns

back to summary

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.

alignColumns	back to summary
private void alignColumns(Table referencedTable) Deprecated as a consequence of `Table` being deprecated. See corresponding docs for further information.

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

disableCreation	back to summary
public void disableCreation()

generatedConstraintNamePrefix	back to summary
public String generatedConstraintNamePrefix() Implements abstract org.hibernate.mapping.Constraint.generatedConstraintNamePrefix. Returns:String Doc from org.hibernate.mapping.Constraint.generatedConstraintNamePrefix. String The prefix to use in generated constraint names. Examples: "UK_", "FK_", and "PK_".

generatedConstraintNamePrefix

back to summary

public String generatedConstraintNamePrefix()

Implements abstract org.hibernate.mapping.Constraint.generatedConstraintNamePrefix.

Returns:String

Doc from org.hibernate.mapping.Constraint.generatedConstraintNamePrefix.

String The prefix to use in generated constraint names. Examples: "UK_", "FK_", and "PK_".

getExportIdentifier	back to summary
public String getExportIdentifier() Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier. Doc from org.hibernate.boot.model.relational.Exportable.getExportIdentifier. Get a unique identifier to make sure we are not exporting the same database structure multiple times. Returns:String The exporting identifier. Annotations @Override

getExportIdentifier

back to summary

public String getExportIdentifier()

Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

Doc from org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

Get a unique identifier to make sure we are not exporting the same database structure multiple times.

Returns:String

The exporting identifier.

Annotations

@Override

getKeyDefinition	back to summary
public String getKeyDefinition()

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() Deprecated as a consequence of `Table` being deprecated. See corresponding docs for further information.

isCascadeDeleteEnabled	back to summary
public boolean isCascadeDeleteEnabled()

isCreationEnabled	back to summary
public boolean isCreationEnabled()

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)

setKeyDefinition	back to summary
public void setKeyDefinition(String keyDefinition)

setName	back to summary
public void setName(String name) Overrides org.hibernate.mapping.Constraint.setName. Annotations @Override

setName

back to summary

public void setName(String name)

Overrides org.hibernate.mapping.Constraint.setName.

Annotations

@Override

setReferencedEntityName	back to summary
public void setReferencedEntityName(String referencedEntityName)

setReferencedTable	back to summary
public void setReferencedTable(Table referencedTable) throws MappingException Deprecated as a consequence of `Table` being deprecated. See corresponding docs for further information.

sqlConstraintString	back to summary
public String sqlConstraintString(SqlStringGenerationContext context, String constraintName, String defaultCatalog, String defaultSchema) Implements abstract org.hibernate.mapping.Constraint.sqlConstraintString. Annotations @Override

sqlConstraintString

back to summary

public String sqlConstraintString(SqlStringGenerationContext context, String constraintName, String defaultCatalog, String defaultSchema)

Implements abstract org.hibernate.mapping.Constraint.sqlConstraintString.

Annotations

@Override

sqlDropString	back to summary
public String sqlDropString(SqlStringGenerationContext context, String defaultCatalog, String defaultSchema) Overrides org.hibernate.mapping.Constraint.sqlDropString. Implements org.hibernate.mapping.RelationalModel.sqlDropString. Annotations @Override

sqlDropString

back to summary

public String sqlDropString(SqlStringGenerationContext context, String defaultCatalog, String defaultSchema)

Overrides org.hibernate.mapping.Constraint.sqlDropString.

Implements org.hibernate.mapping.RelationalModel.sqlDropString.

Annotations

@Override

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.

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.

public Class ForeignKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail