Top Description Methods
org.hibernate.boot.model.source.spi

public Interface ForeignKeyContributingSource

Known Direct Subinterfaces
org.hibernate.boot.model.source.spi.JoinedSubclassEntitySource, org.hibernate.boot.model.source.spi.PluralAttributeElementSourceManyToMany, org.hibernate.boot.model.source.spi.SecondaryTableSource, org.hibernate.boot.model.source.spi.PluralAttributeKeySource, org.hibernate.boot.model.source.spi.SingularAttributeSourceToOne
Additional contract for things which describe foreign keys.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the FK constraint should be created, false if not.
createForeignKeyConstraint()

Primarily exists to support JPA's @ForeignKey(NO_CONSTRAINT).

public String

Returns:

The user supplied foreign key name.
getExplicitForeignKeyName()

Retrieve the name of the foreign key as supplied by the user, or null if the user supplied none.

public boolean

Returns:

true, if the cascade delete is enabled; false, otherwise.
isCascadeDeleteEnabled()

Is "cascade delete" enabled for the foreign key?

Method Detail

createForeignKeyConstraintback to summary
public boolean createForeignKeyConstraint()

Primarily exists to support JPA's @ForeignKey(NO_CONSTRAINT).

Returns:boolean

true if the FK constraint should be created, false if not.

getExplicitForeignKeyNameback to summary
public String getExplicitForeignKeyName()

Retrieve the name of the foreign key as supplied by the user, or null if the user supplied none.

Returns:String

The user supplied foreign key name.

isCascadeDeleteEnabledback to summary
public boolean isCascadeDeleteEnabled()

Is "cascade delete" enabled for the foreign key? In other words, if a record in the parent (referenced) table is deleted, should the corresponding records in the child table automatically be deleted?

Returns:boolean

true, if the cascade delete is enabled; false, otherwise.