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

Method Summary

Modifier and Type	Method and Description
public TableGroup	createRootTableGroupJoin(NavigablePath The NavigablePath to the join navigablePath, TableGroup The join's (L)eft-(H)and (S)ide lhs, String explicitSourceAlias, SqlAliasBase A specific SqlAliasBase to use. May be `null` indicating one should be created using the SqlAliasBaseGenerator from `creationState` explicitSqlAliasBase, SqlAstJoinType An explicit join-type. May be null to signal that the join is for an implicit path. sqlAstJoinType, boolean fetched, Consumer<Predicate> Consumer for additional predicates from the producer's mapping. predicateConsumer, SqlAstCreationState creationState) Create the "join", but return a TableGroup.
public TableGroupJoin	createTableGroupJoin(NavigablePath The NavigablePath to the join navigablePath, TableGroup The join's (L)eft-(H)and (S)ide lhs, String explicitSourceAlias, SqlAliasBase A specific SqlAliasBase to use. May be `null` indicating one should be created using the SqlAliasBaseGenerator from `creationState` explicitSqlAliasBase, SqlAstJoinType An explicit join-type. May be null to signal that the join is for an implicit path. sqlAstJoinType, boolean fetched, boolean Indicates there are explicit, additional predicates (from an SQM tree ON/WITH clause) addsPredicate, SqlAstCreationState creationState) Create a TableGroupJoin.
public default SqlAstJoinType	determineSqlJoinType(TableGroup lhs, SqlAstJoinType requestedJoinType, boolean fetched)
public SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
public boolean	isSimpleJoinPredicate(Predicate predicate) Returns whether the given predicate is a simple join predicate for this attribute.

Inherited from org.hibernate.sql.ast.tree.from.TableGroupProducer:: containsTableReference getSqlAliasStem

Method Detail

createRootTableGroupJoin back to summary

createRootTableGroupJoin	back to summary
public TableGroup createRootTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType sqlAstJoinType, boolean fetched, Consumer<Predicate> predicateConsumer, SqlAstCreationState creationState) Create the "join", but return a TableGroup. Intended for creating sub-query correlations. E.g., given from SomeEntity e where exists ( select 1 from AnotherEntity a where e.association.attr = 1 ) We call this for the `e.association` path. Parameters navigablePath:NavigablePath The NavigablePath to the join lhs:TableGroup The join's (L)eft-(H)and (S)ide explicitSqlAliasBase:SqlAliasBase A specific SqlAliasBase to use. May be `null` indicating one should be created using the SqlAliasBaseGenerator from `creationState` sqlAstJoinType:SqlAstJoinType An explicit join-type. May be null to signal that the join is for an implicit path. predicateConsumer:Consumer<Predicate> Consumer for additional predicates from the producer's mapping.

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

Create the "join", but return a TableGroup. Intended for creating sub-query correlations. E.g., given

    from SomeEntity e
    where exists (
        select 1
        from AnotherEntity a
        where e.association.attr = 1
    )

We call this for the `e.association` path.

Parameters

navigablePath:NavigablePath: The NavigablePath to the join
lhs:TableGroup: The join's (L)eft-(H)and (S)ide
explicitSqlAliasBase:SqlAliasBase: A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState
sqlAstJoinType:SqlAstJoinType: An explicit join-type. May be null to signal that the join is for an implicit path.
predicateConsumer:Consumer<Predicate>: Consumer for additional predicates from the producer's mapping.

createTableGroupJoin back to summary

createTableGroupJoin	back to summary
public TableGroupJoin createTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType sqlAstJoinType, boolean fetched, boolean addsPredicate, SqlAstCreationState creationState) Create a TableGroupJoin. Parameters navigablePath:NavigablePath The NavigablePath to the join lhs:TableGroup The join's (L)eft-(H)and (S)ide explicitSqlAliasBase:SqlAliasBase A specific SqlAliasBase to use. May be `null` indicating one should be created using the SqlAliasBaseGenerator from `creationState` sqlAstJoinType:SqlAstJoinType An explicit join-type. May be null to signal that the join is for an implicit path. addsPredicate:boolean Indicates there are explicit, additional predicates (from an SQM tree ON/WITH clause)

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

Create a TableGroupJoin.

Parameters

navigablePath:NavigablePath: The NavigablePath to the join
lhs:TableGroup: The join's (L)eft-(H)and (S)ide
explicitSqlAliasBase:SqlAliasBase: A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState
sqlAstJoinType:SqlAstJoinType: An explicit join-type. May be null to signal that the join is for an implicit path.
addsPredicate:boolean: Indicates there are explicit, additional predicates (from an SQM tree ON/WITH clause)

determineSqlJoinType	back to summary
public default SqlAstJoinType determineSqlJoinType(TableGroup lhs, SqlAstJoinType requestedJoinType, boolean fetched)

getDefaultSqlAstJoinType	back to summary
public SqlAstJoinType getDefaultSqlAstJoinType(TableGroup parentTableGroup)

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

public Interface TableGroupJoinProducer

Method Summary

Method Detail