Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.sql.ast.tree.from.TableGroup

Method Summary

Modifier and Type	Method and Description
public default void	accept(SqlAstWalker sqlTreeWalker) Implements org.hibernate.sql.ast.tree.SqlAstNode.accept.
public 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. `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`
public void	addTableGroupJoin(TableGroupJoin join)
public void	applyAffectedTableNames(Consumer<String> nameCollector)
public default void	applySqlSelections(DomainResultCreationState creationState) Implements org.hibernate.query.sqm.sql.internal.DomainResultProducer.applySqlSelections. Used when this producer is a selection in a sub-query.
public boolean	canUseInnerJoins()
public default DomainResult<J>	createDomainResult(String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.query.sqm.sql.internal.DomainResultProducer.createDomainResult. Produce the domain query
public default TableGroupJoin	findCompatibleJoin(TableGroupJoinProducer joinProducer, SqlAstJoinType requestedJoinType)
public default TableGroup	findCompatibleJoinedGroup(TableGroupJoinProducer joinProducer, SqlAstJoinType requestedJoinType)
public default TableGroupJoin	findTableGroupJoin(TableGroup tableGroup)
public String	getGroupAlias() If we want to use CTE for TableGroup rendering we will need to know the alias we can use for the group
public ModelPartContainer	getModelPart()
public NavigablePath	getNavigablePath() Redeclares org.hibernate.query.sqm.sql.internal.SqmPathInterpretation.getNavigablePath.
public List<TableGroupJoin>	getNestedTableGroupJoins()
public TableReference	getPrimaryTableReference()
public String	getSourceAlias()
public List<TableGroupJoin>	getTableGroupJoins()
public List<TableReferenceJoin>	getTableReferenceJoins()
public default boolean	hasRealJoins()
public default boolean	isFetched()
public default boolean	isInitialized() If this is a lazy table group, it may report that it is not initialized, which would also mean that a join referring to this table group should not be rendered.
public default boolean	isLateral()
public default boolean	isRealTableGroup()
public default boolean	isVirtual() Utility method that indicates weather this table group is virtual or not
public void	prependTableGroupJoin(NavigablePath navigablePath, TableGroupJoin join) Adds the given table group join before a join as found via the given navigable path.
public void	visitNestedTableGroupJoins(Consumer<TableGroupJoin> consumer)
public void	visitTableGroupJoins(Consumer<TableGroupJoin> consumer)

Inherited from org.hibernate.query.sqm.sql.internal.SqmPathInterpretation:: getExpressionType getSqlExpression
Inherited from org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier:: getTableReference getTableReference getTableReference getTableReference resolveTableReference resolveTableReference resolveTableReference

Method Detail

accept	back to summary
public default void accept(SqlAstWalker sqlTreeWalker) Implements org.hibernate.sql.ast.tree.SqlAstNode.accept. Annotations @Override

back to summary

public default void accept(SqlAstWalker sqlTreeWalker)

Implements org.hibernate.sql.ast.tree.SqlAstNode.accept.

Annotations

@Override

addNestedTableGroupJoin back to summary

addNestedTableGroupJoin	back to summary
public 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. `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`

public 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. 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

addTableGroupJoin	back to summary
public void addTableGroupJoin(TableGroupJoin join)

applyAffectedTableNames	back to summary
public void applyAffectedTableNames(Consumer<String> nameCollector)

applySqlSelections	back to summary
public default void applySqlSelections(DomainResultCreationState creationState) Implements org.hibernate.query.sqm.sql.internal.DomainResultProducer.applySqlSelections. Doc from org.hibernate.query.sqm.sql.internal.DomainResultProducer.applySqlSelections. Used when this producer is a selection in a sub-query. The DomainResult is only needed for root query of a SELECT statement. This default impl assumes this producer is a true (Sql)Expression Annotations @Override

canUseInnerJoins	back to summary
public boolean canUseInnerJoins()

createDomainResult	back to summary
public default DomainResult<J> createDomainResult(String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.query.sqm.sql.internal.DomainResultProducer.createDomainResult. Doc from org.hibernate.query.sqm.sql.internal.DomainResultProducer.createDomainResult. Produce the domain query Annotations @Override

findCompatibleJoin	back to summary
public default TableGroupJoin findCompatibleJoin(TableGroupJoinProducer joinProducer, SqlAstJoinType requestedJoinType)

findCompatibleJoinedGroup	back to summary
public default TableGroup findCompatibleJoinedGroup(TableGroupJoinProducer joinProducer, SqlAstJoinType requestedJoinType)

findTableGroupJoin	back to summary
public default TableGroupJoin findTableGroupJoin(TableGroup tableGroup)

getGroupAlias	back to summary
public String getGroupAlias() If we want to use CTE for TableGroup rendering we will need to know the alias we can use for the group

getModelPart	back to summary
public ModelPartContainer getModelPart()

getNavigablePath	back to summary
public NavigablePath getNavigablePath() Redeclares org.hibernate.query.sqm.sql.internal.SqmPathInterpretation.getNavigablePath.

getNestedTableGroupJoins	back to summary
public List<TableGroupJoin> getNestedTableGroupJoins()

getPrimaryTableReference	back to summary
public TableReference getPrimaryTableReference()

getSourceAlias	back to summary
public String getSourceAlias()

getTableGroupJoins	back to summary
public List<TableGroupJoin> getTableGroupJoins()

getTableReferenceJoins	back to summary
public List<TableReferenceJoin> getTableReferenceJoins()

hasRealJoins	back to summary
public default boolean hasRealJoins()

isFetched	back to summary
public default boolean isFetched()

isInitialized	back to summary
public default boolean isInitialized() If this is a lazy table group, it may report that it is not initialized, which would also mean that a join referring to this table group should not be rendered.

isLateral	back to summary
public default boolean isLateral()

isRealTableGroup	back to summary
public default boolean isRealTableGroup()

isVirtual	back to summary
public default boolean isVirtual() Utility method that indicates weather this table group is virtual or not

prependTableGroupJoin	back to summary
public void prependTableGroupJoin(NavigablePath navigablePath, TableGroupJoin join) Adds the given table group join before a join as found via the given navigable path.

visitNestedTableGroupJoins	back to summary
public void visitNestedTableGroupJoins(Consumer<TableGroupJoin> consumer)

visitTableGroupJoins	back to summary
public void visitTableGroupJoins(Consumer<TableGroupJoin> consumer)

public Interface TableGroup

Method Summary

Method Detail