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

public Interface SecondaryTableSource

extends ForeignKeyContributingSource
Known Direct Implementers
org.hibernate.boot.model.source.internal.hbm.SecondaryTableSourceImpl
Imports
java.util.List, org.hibernate.boot.model.CustomSql, org.hibernate.engine.FetchStyle
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public String
getComment()

public CustomSql

Returns:

The custom delete SQL
getCustomSqlDelete()

Obtain the custom SQL to be used for deletes for this entity

public CustomSql

Returns:

The custom insert SQL
getCustomSqlInsert()

Obtain the custom SQL to be used for inserts for this entity

public CustomSql

Returns:

The custom update SQL
getCustomSqlUpdate()

Obtain the custom SQL to be used for updates for this entity

public FetchStyle
getFetchStyle()

public String
getLogicalTableNameForContainedColumns()

public List<ColumnSource>

Returns:

The columns defining the primary key for this secondary table
getPrimaryKeyColumnSources()

Retrieves the columns defines as making up this secondary tables primary key.

public TableSpecificationSource

Returns:

The joined table.
getTableSource()

Obtain the table being joined to.

public boolean
isCascadeDeleteEnabled()

Redeclares org.hibernate.boot.model.source.spi.ForeignKeyContributingSource.isCascadeDeleteEnabled.

Is "cascade delete" enabled for the foreign key?
public boolean
isInverse()

public boolean
isOptional()

Inherited from org.hibernate.boot.model.source.spi.ForeignKeyContributingSource:
createForeignKeyConstraintgetExplicitForeignKeyName

Method Detail

getCommentback to summary
public String getComment()
getCustomSqlDeleteback to summary
public CustomSql getCustomSqlDelete()

Obtain the custom SQL to be used for deletes for this entity

Returns:CustomSql

The custom delete SQL

getCustomSqlInsertback to summary
public CustomSql getCustomSqlInsert()

Obtain the custom SQL to be used for inserts for this entity

Returns:CustomSql

The custom insert SQL

getCustomSqlUpdateback to summary
public CustomSql getCustomSqlUpdate()

Obtain the custom SQL to be used for updates for this entity

Returns:CustomSql

The custom update SQL

getFetchStyleback to summary
public FetchStyle getFetchStyle()
getLogicalTableNameForContainedColumnsback to summary
public String getLogicalTableNameForContainedColumns()
getPrimaryKeyColumnSourcesback to summary
public List<ColumnSource> getPrimaryKeyColumnSources()

Retrieves the columns defines as making up this secondary tables primary key. Each entry should have a corresponding entry in the foreign-key columns described by the ForeignKeyContributingSource aspect of this contract.

Returns:List<ColumnSource>

The columns defining the primary key for this secondary table

getTableSourceback to summary
public TableSpecificationSource getTableSource()

Obtain the table being joined to.

Returns:TableSpecificationSource

The joined table.

isCascadeDeleteEnabledback to summary
public boolean isCascadeDeleteEnabled()

Redeclares org.hibernate.boot.model.source.spi.ForeignKeyContributingSource.isCascadeDeleteEnabled.

Doc from org.hibernate.boot.model.source.spi.ForeignKeyContributingSource.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.

isInverseback to summary
public boolean isInverse()
isOptionalback to summary
public boolean isOptional()