Package org.hibernate.sql.ast.tree.from

Class MutatingTableReferenceGroupWrapper

java.lang.Object

org.hibernate.sql.ast.tree.from.MutatingTableReferenceGroupWrapper

All Implemented Interfaces:

DomainResultProducer, SqmPathInterpretation, SqlSelectionProducer, Expression, ColumnReferenceQualifier, TableGroup, SqlAstNode

public class MutatingTableReferenceGroupWrapper
extends Object
implements TableGroup

Acts as a TableGroup for DML query operations. It is used to simply wrap the TableReference of the "mutating table"

Constructor Summary

Constructors

Constructor	Description
MutatingTableReferenceGroupWrapper(NavigablePath navigablePath, ModelPartContainer modelPart, NamedTableReference mutatingTableReference)

Method Summary

Modifier and Type	Method	Description
void	addNestedTableGroupJoin(TableGroupJoin join)	A nested table group join is a join against a table group, that is ensured to be joined against the primary table reference and table reference joins in isolation, prior to doing other table group joins e.g.
void	addTableGroupJoin(TableGroupJoin join)
void	applyAffectedTableNames(Consumer<String> nameCollector)
boolean	canUseInnerJoins()
ModelPart	getExpressionType()	The type for this expression
String	getGroupAlias()	If we want to use CTE for TableGroup rendering we will need to know the alias we can use for the group
ModelPartContainer	getModelPart()
NavigablePath	getNavigablePath()
List<TableGroupJoin>	getNestedTableGroupJoins()
TableReference	getPrimaryTableReference()
String	getSourceAlias()
List<TableGroupJoin>	getTableGroupJoins()
TableReference	getTableReference(NavigablePath navigablePath, String tableExpression, boolean allowFkOptimization, boolean resolve)	Returns the table reference for the table expression, or null if not found.
List<TableReferenceJoin>	getTableReferenceJoins()
void	prependTableGroupJoin(NavigablePath navigablePath, TableGroupJoin join)	Adds the given table group join before a join as found via the given navigable path.
TableReference	resolveTableReference(NavigablePath navigablePath, String tableExpression, boolean allowFkOptimization)	Like ColumnReferenceQualifier.getTableReference(NavigablePath, String, boolean, boolean), but will throw an exception if no table reference can be found, even after resolving possible table reference joins.
void	visitNestedTableGroupJoins(Consumer<TableGroupJoin> consumer)
void	visitTableGroupJoins(Consumer<TableGroupJoin> consumer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier

getTableReference, getTableReference, resolveTableReference, resolveTableReference

Methods inherited from interface org.hibernate.sql.ast.tree.expression.Expression

createSqlSelection, getColumnReference

Methods inherited from interface org.hibernate.query.sqm.sql.internal.SqmPathInterpretation

getSqlExpression

Methods inherited from interface org.hibernate.sql.ast.tree.from.TableGroup

accept, applySqlSelections, createDomainResult, isFetched, isInitialized, isLateral, isRealTableGroup

Constructor Detail

MutatingTableReferenceGroupWrapper

public MutatingTableReferenceGroupWrapper(NavigablePath navigablePath,
                                          ModelPartContainer modelPart,
                                          NamedTableReference mutatingTableReference)

Method Detail

getNavigablePath

public NavigablePath getNavigablePath()

Specified by:

getNavigablePath in interface SqmPathInterpretation

Specified by:

getNavigablePath in interface TableGroup

getExpressionType

public ModelPart getExpressionType()

Description copied from interface: Expression

The type for this expression

Specified by:

getExpressionType in interface Expression

Specified by:

getExpressionType in interface SqmPathInterpretation

getGroupAlias

public String getGroupAlias()

Description copied from interface: TableGroup

If we want to use CTE for TableGroup rendering we will need to know the alias we can use for the group

Specified by:

getGroupAlias in interface TableGroup

getModelPart

public ModelPartContainer getModelPart()

Specified by:

getModelPart in interface TableGroup

getPrimaryTableReference

public TableReference getPrimaryTableReference()

Specified by:

getPrimaryTableReference in interface TableGroup

getTableReference

public TableReference getTableReference(NavigablePath navigablePath,
                                        String tableExpression,
                                        boolean allowFkOptimization,
                                        boolean resolve)

Description copied from interface: ColumnReferenceQualifier

Returns the table reference for the table expression, or null if not found.

Specified by:

getTableReference in interface ColumnReferenceQualifier

Parameters:

navigablePath - The path for which to look up the table reference, may be null

tableExpression - The table expression for which to look up the table reference

allowFkOptimization - Whether a foreign key optimization is allowed i.e. use the FK column on the key-side

resolve - Whether to potentially create table reference joins for this table group

resolveTableReference

public TableReference resolveTableReference(NavigablePath navigablePath,
                                            String tableExpression,
                                            boolean allowFkOptimization)

Description copied from interface: ColumnReferenceQualifier

Like ColumnReferenceQualifier.getTableReference(NavigablePath, String, boolean, boolean), but will throw an exception if no table reference can be found, even after resolving possible table reference joins.

Specified by:

resolveTableReference in interface ColumnReferenceQualifier

Parameters:

navigablePath - The path for which to look up the table reference, may be null

tableExpression - The table expression for which to look up the table reference

allowFkOptimization - Whether a foreign key optimization is allowed i.e. use the FK column on the key-side

applyAffectedTableNames

public void applyAffectedTableNames(Consumer<String> nameCollector)

Specified by:

applyAffectedTableNames in interface TableGroup

getSourceAlias

public String getSourceAlias()

Specified by:

getSourceAlias in interface TableGroup

getTableGroupJoins

public List<TableGroupJoin> getTableGroupJoins()

Specified by:

getTableGroupJoins in interface TableGroup

getNestedTableGroupJoins

public List<TableGroupJoin> getNestedTableGroupJoins()

Specified by:

getNestedTableGroupJoins in interface TableGroup

canUseInnerJoins

public boolean canUseInnerJoins()

Specified by:

canUseInnerJoins in interface TableGroup

addTableGroupJoin

public void addTableGroupJoin(TableGroupJoin join)

Specified by:

addTableGroupJoin in interface TableGroup

prependTableGroupJoin

public void prependTableGroupJoin(NavigablePath navigablePath,
                                  TableGroupJoin join)

Description copied from interface: TableGroup

Adds the given table group join before a join as found via the given navigable path.

Specified by:

prependTableGroupJoin in interface TableGroup

addNestedTableGroupJoin

public void addNestedTableGroupJoin(TableGroupJoin join)

Description copied from interface: TableGroup

A nested table group join is a join against a table group, that is ensured to be joined against the primary table reference and table reference joins in isolation, prior to doing other table group joins e.g. select * from entity1 e left join ( collection_table c1 join association a on a.id = c1.target_id ) on c1.entity_id = e.id and c1.key = 1 is modeled as TableGroup( primaryTableReference = TableReference(entity1, e), tableGroupJoins = [ TableGroupJoin( TableGroup( primaryTableReference = TableReference(collection_table, c1), nestedTableGroupJoins = [ TableGroupJoin( TableGroup( primaryTableReference = TableReference(association, a) ) ) ] ) ) ] ) This is necessary to correctly retain the cardinality of an HQL join like e.g. from Entity1 e left join e.collectionAssociation c on key(c) = 1

Specified by:

addNestedTableGroupJoin in interface TableGroup

visitTableGroupJoins

public void visitTableGroupJoins(Consumer<TableGroupJoin> consumer)

Specified by:

visitTableGroupJoins in interface TableGroup

visitNestedTableGroupJoins

public void visitNestedTableGroupJoins(Consumer<TableGroupJoin> consumer)

Specified by:

visitNestedTableGroupJoins in interface TableGroup

getTableReferenceJoins

public List<TableReferenceJoin> getTableReferenceJoins()

Specified by:

getTableReferenceJoins in interface TableGroup