Top Description Inners Methods
org.hibernate.sql.model

public Interface TableMapping

extends TableDetails
Known Direct Implementers
org.hibernate.persister.collection.mutation.CollectionTableMapping, org.hibernate.persister.entity.mutation.EntityTableMapping
Imports
org.hibernate.jdbc.Expectation, org.hibernate.metamodel.mapping.TableDetails
Describes a table as far as Hibernate understands it from mapping details

Includes basic details, in addition to details about the table in relation to a particular MutationTarget

Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TableMapping.MutationDetails

Details for the mutation of a table

Method Summary

Modifier and TypeMethod and Description
public default boolean
containsTableName(String tableName)

public TableMapping.MutationDetails
getDeleteDetails()

Details for deleting from this table

public TableMapping.MutationDetails
getInsertDetails()

Details for insertion into this table

public int
getRelativePosition()

The position of the table relative to others for the MutationTarget

public String
getTableName()

Redeclares org.hibernate.metamodel.mapping.TableDetails.getTableName.

The name of the mapped table
public TableMapping.MutationDetails
getUpdateDetails()

Details for updating this table

public boolean
isCascadeDeleteEnabled()

Whether deletions are cascaded to this table at the database level.

public boolean
isIdentifierTable()

Redeclares org.hibernate.metamodel.mapping.TableDetails.isIdentifierTable.

Whether this table holds the identifier for the MutationTarget
public boolean
isInverse()

Whether the table is mapped as inverse

public boolean
isOptional()

Whether the table is mapped as optional

Inherited from org.hibernate.metamodel.mapping.TableDetails:
getKeyDetails

Method Detail

containsTableNameback to summary
public default boolean containsTableName(String tableName)
getDeleteDetailsback to summary
public TableMapping.MutationDetails getDeleteDetails()

Details for deleting from this table

getInsertDetailsback to summary
public TableMapping.MutationDetails getInsertDetails()

Details for insertion into this table

getRelativePositionback to summary
public int getRelativePosition()

The position of the table relative to others for the MutationTarget

getTableNameback to summary
public String getTableName()

Redeclares org.hibernate.metamodel.mapping.TableDetails.getTableName.

The name of the mapped table

getUpdateDetailsback to summary
public TableMapping.MutationDetails getUpdateDetails()

Details for updating this table

isCascadeDeleteEnabledback to summary
public boolean isCascadeDeleteEnabled()

Whether deletions are cascaded to this table at the database level.

API Note

When true, isIdentifierTable() will generally be false

See Also
org.hibernate.annotations.OnDelete
isIdentifierTableback to summary
public boolean isIdentifierTable()

Redeclares org.hibernate.metamodel.mapping.TableDetails.isIdentifierTable.

Whether this table holds the identifier for the MutationTarget

isInverseback to summary
public boolean isInverse()

Whether the table is mapped as inverse

isOptionalback to summary
public boolean isOptional()

Whether the table is mapped as optional

org.hibernate.sql.model back to summary

public Class TableMapping.MutationDetails

extends Object
Class Inheritance
Details for the mutation of a table

Field Summary

Modifier and TypeField and Description
private final boolean
callable

private final String
customSql

private final boolean
dynamicMutation

private final Expectation
expectation

private final MutationType
mutationType

Constructor Summary

AccessConstructor and Description
public
MutationDetails(MutationType mutationType, Expectation expectation, String customSql, boolean callable)

public
MutationDetails(MutationType mutationType, Expectation expectation, String customSql, boolean callable, boolean dynamicMutation)

Method Summary

Modifier and TypeMethod and Description
public String
getCustomSql()

Custom, application-provided SQL for this mutation (if one).

public Expectation
getExpectation()

The expectation for this mutation

public MutationType
getMutationType()

The type of mutation being detailed

public boolean
isCallable()

Whether custom SQL should be treated as callable (function / procedure)

public boolean
isDynamicMutation()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

callableback to summary
private final boolean callable
customSqlback to summary
private final String customSql
dynamicMutationback to summary
private final boolean dynamicMutation
expectationback to summary
private final Expectation expectation
mutationTypeback to summary
private final MutationType mutationType

Constructor Detail

MutationDetailsback to summary
public MutationDetails(MutationType mutationType, Expectation expectation, String customSql, boolean callable)
MutationDetailsback to summary
public MutationDetails(MutationType mutationType, Expectation expectation, String customSql, boolean callable, boolean dynamicMutation)

Method Detail

getCustomSqlback to summary
public String getCustomSql()

Custom, application-provided SQL for this mutation (if one). Will return null if no custom SQL was provided indicating Hibernate will generate the SQL based on the mapping

getExpectationback to summary
public Expectation getExpectation()

The expectation for this mutation

getMutationTypeback to summary
public MutationType getMutationType()

The type of mutation being detailed

isCallableback to summary
public boolean isCallable()

Whether custom SQL should be treated as callable (function / procedure)

isDynamicMutationback to summary
public boolean isDynamicMutation()