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

Interface TableGroupJoinProducer

All Superinterfaces:

Bindable, JdbcMappingContainer, MappingModelExpressible, ModelPart, ModelPartContainer, TableGroupProducer

All Known Subinterfaces:

CompositeIdentifierMapping, DiscriminatedAssociationModelPart, EmbeddableValuedFetchable, EmbeddableValuedModelPart, EntityAssociationMapping, NonAggregatedIdentifierMapping, PluralAttributeMapping

All Known Implementing Classes:

AbstractCompositeIdentifierMapping, AnonymousTupleEmbeddableValuedModelPart, AnonymousTupleEmbeddedEntityIdentifierMapping, AnonymousTupleEntityValuedModelPart, AnonymousTupleNonAggregatedEntityIdentifierMapping, DiscriminatedAssociationAttributeMapping, DiscriminatedCollectionPart, EmbeddedAttributeMapping, EmbeddedCollectionPart, EmbeddedIdentifierMappingImpl, InverseNonAggregatedIdentifierMapping, ManyToManyCollectionPart, NonAggregatedIdentifierMappingImpl, OneToManyCollectionPart, PluralAttributeMappingImpl, ToOneAttributeMapping, VirtualEmbeddedAttributeMapping

public interface TableGroupJoinProducer
extends TableGroupProducer

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.ModelPart

ModelPart.IndexedJdbcValueConsumer, ModelPart.JdbcValueConsumer

Method Summary

Modifier and Type	Method	Description
TableGroup	createRootTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAstJoinType sqlAstJoinType, boolean fetched, Consumer<Predicate> predicateConsumer, SqlAliasBaseGenerator aliasBaseGenerator, SqlExpressionResolver sqlExpressionResolver, FromClauseAccess fromClauseAccess, SqlAstCreationContext creationContext)	Create a TableGroupJoin as defined for this producer, but as root TableGroup.
default TableGroup	createRootTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAstJoinType sqlAstJoinType, boolean fetched, Consumer<Predicate> predicateConsumer, SqlAstCreationState creationState)	Create a TableGroupJoin as defined for this producer, but as root TableGroup.
TableGroupJoin	createTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAstJoinType sqlAstJoinType, boolean fetched, boolean addsPredicate, SqlAliasBaseGenerator aliasBaseGenerator, SqlExpressionResolver sqlExpressionResolver, FromClauseAccess fromClauseAccess, SqlAstCreationContext creationContext)	Create a TableGroupJoin as defined for this producer The sqlAstJoinType may be null to signal that the join is for an implicit path.
default TableGroupJoin	createTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAstJoinType sqlAstJoinType, boolean fetched, boolean addsPredicate, SqlAstCreationState creationState)	Create a TableGroupJoin as defined for this producer The sqlAstJoinType may be null to signal that the join is for an implicit path.
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
boolean	isSimpleJoinPredicate(Predicate predicate)	Returns whether the given predicate is a simple join predicate for this attribute.

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

disassemble, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, getJdbcMappings, getJdbcTypeCount

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMappingContainer

forEachJdbcType

Methods inherited from interface org.hibernate.metamodel.mapping.ModelPart

applySqlSelections, applySqlSelections, areEqual, asAttributeMapping, breakDownJdbcValues, createDomainResult, decompose, findContainingEntityMapping, forEachSelectable, forEachSelectable, getJavaType, getNavigableRole, getPartMappingType, getPartName, hasPartitionedSelectionMapping, isVirtual

Methods inherited from interface org.hibernate.metamodel.mapping.ModelPartContainer

findByPath, findSubPart, forEachSubPart, forEachSubPart, visitSubParts

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

containsTableReference, getSqlAliasStem

Method Detail

getDefaultSqlAstJoinType

SqlAstJoinType getDefaultSqlAstJoinType(TableGroup parentTableGroup)

isSimpleJoinPredicate

boolean isSimpleJoinPredicate(Predicate predicate)

Returns whether the given predicate is a simple join predicate for this attribute. This is useful to understand if a predicate has additional conjunctions other than the FK related predicate.

createTableGroupJoin

default TableGroupJoin createTableGroupJoin(NavigablePath navigablePath,
                                            TableGroup lhs,
                                            String explicitSourceAlias,
                                            SqlAstJoinType sqlAstJoinType,
                                            boolean fetched,
                                            boolean addsPredicate,
                                            SqlAstCreationState creationState)

Create a TableGroupJoin as defined for this producer The sqlAstJoinType may be null to signal that the join is for an implicit path. When addsPredicate is true, the SQM join for the attribute contains an explicit ON clause, and is false otherwise.

createTableGroupJoin

TableGroupJoin createTableGroupJoin(NavigablePath navigablePath,
                                    TableGroup lhs,
                                    String explicitSourceAlias,
                                    SqlAstJoinType sqlAstJoinType,
                                    boolean fetched,
                                    boolean addsPredicate,
                                    SqlAliasBaseGenerator aliasBaseGenerator,
                                    SqlExpressionResolver sqlExpressionResolver,
                                    FromClauseAccess fromClauseAccess,
                                    SqlAstCreationContext creationContext)

Create a TableGroupJoin as defined for this producer The sqlAstJoinType may be null to signal that the join is for an implicit path. When addsPredicate is true, the SQM join for the attribute contains an explicit ON clause, and is false otherwise.

createRootTableGroupJoin

default TableGroup createRootTableGroupJoin(NavigablePath navigablePath,
                                            TableGroup lhs,
                                            String explicitSourceAlias,
                                            SqlAstJoinType sqlAstJoinType,
                                            boolean fetched,
                                            Consumer<Predicate> predicateConsumer,
                                            SqlAstCreationState creationState)

Create a TableGroupJoin as defined for this producer, but as root TableGroup. The main purpose of this is for correlating an association in a subquery i.e. `... alias where exists (select 1 from SomeEntity e where alias.association.attr = 1)`. The sqlAstJoinType may be null to signal that the join is for an implicit path.

createRootTableGroupJoin

TableGroup createRootTableGroupJoin(NavigablePath navigablePath,
                                    TableGroup lhs,
                                    String explicitSourceAlias,
                                    SqlAstJoinType sqlAstJoinType,
                                    boolean fetched,
                                    Consumer<Predicate> predicateConsumer,
                                    SqlAliasBaseGenerator aliasBaseGenerator,
                                    SqlExpressionResolver sqlExpressionResolver,
                                    FromClauseAccess fromClauseAccess,
                                    SqlAstCreationContext creationContext)

Create a TableGroupJoin as defined for this producer, but as root TableGroup. The main purpose of this is for correlating an association in a subquery i.e. `... alias where exists (select 1 from SomeEntity e where alias.association.attr = 1)`. The sqlAstJoinType may be null to signal that the join is for an implicit path.