Package org.hibernate.metamodel.mapping.internal

Class ManyToManyCollectionPart

java.lang.Object

org.hibernate.metamodel.mapping.internal.AbstractEntityCollectionPart

org.hibernate.metamodel.mapping.internal.ManyToManyCollectionPart

All Implemented Interfaces:

Association, Bindable, CollectionPart, EntityAssociationMapping, EntityValuedModelPart, EntityCollectionPart, JdbcMappingContainer, MappingModelExpressible, ModelPart, ModelPartContainer, SelectableMappings, ValuedModelPart, ValueMapping, LazyTableGroup.ParentTableGroupUseChecker, TableGroupJoinProducer, TableGroupProducer, EntityValuedFetchable, Fetchable, FetchableContainer, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible

public class ManyToManyCollectionPart
extends AbstractEntityCollectionPart
implements EntityAssociationMapping, LazyTableGroup.ParentTableGroupUseChecker

Entity-valued collection-part mapped through a join table. Models both

• ManyToMany mappings
• OneToMany with JoinTable mappings

``` user( id, ... ) group( id, ... ) membership( user_fk, group_fk ) `Group.membership` table: membership key: group_fk element: user_fk ```

Nested Class Summary

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

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

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

CollectionPart.Nature

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

EntityCollectionPart.Cardinality

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

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Field Summary

Fields inherited from class org.hibernate.metamodel.mapping.internal.AbstractEntityCollectionPart

targetKeyPropertyNames

Constructor Summary

Constructors

Constructor	Description
ManyToManyCollectionPart(CollectionPart.Nature nature, Collection collectionBootDescriptor, CollectionPersister collectionDescriptor, EntityMappingType associatedEntityDescriptor, NotFoundAction notFoundAction, MappingModelCreationProcess creationProcess)
ManyToManyCollectionPart(CollectionPart.Nature nature, Collection collectionBootDescriptor, CollectionPersister collectionDescriptor, EntityMappingType associatedEntityDescriptor, MappingModelCreationProcess creationProcess)

Method Summary

Modifier and Type	Method	Description
<X,Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Breaks down the domain value to its constituent JDBC values.
boolean	canUseParentTableGroup(TableGroupProducer producer, NavigablePath navigablePath, ValuedModelPart valuedModelPart)
LazyTableGroup	createRootTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType requestedJoinType, boolean fetched, Consumer<Predicate> predicateConsumer, SqlAstCreationState creationState)	Create the "join", but return a TableGroup.
TableGroupJoin	createTableGroupJoin(NavigablePath navigablePath, TableGroup lhs, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, SqlAstJoinType requestedJoinType, boolean fetched, boolean addsPredicate, SqlAstCreationState creationState)	Create a TableGroupJoin.
<X,Y> int	decompose(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Similar to ModelPart.breakDownJdbcValues(Object, int, Object, Object, JdbcValueBiConsumer, SharedSessionContractImplementor), but this method is supposed to be used for decomposing values for assignment expressions.
ModelPart	findSubPart(String name, EntityMappingType targetType)
boolean	finishInitialization(CollectionPersister collectionDescriptor, Collection bootCollectionDescriptor, String fkTargetModelPartName, MappingModelCreationProcess creationProcess)	Perform any delayed initialization.
void	forEachInsertable(SelectableConsumer consumer)
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits each selectable mapping with the selectable index offset by the given value.
void	forEachUpdatable(SelectableConsumer consumer)
EntityCollectionPart.Cardinality	getCardinality()
String	getContainingTableExpression()	The table which contains the columns mapped by this value
SqlAstJoinType	getDefaultSqlAstJoinType(TableGroup parentTableGroup)
ForeignKeyDescriptor	getForeignKeyDescriptor()	The descriptor, allowing access to column(s), etc
ModelPart	getInclusionCheckPart()
JdbcMapping	getJdbcMapping(int index)
ModelPart	getKeyTargetMatchPart()	The model sub-part relative to the associated entity type that is the target of this association's foreign-key
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
ForeignKeyDescriptor.Nature	getSideNature()	Indicates which "side" of the foreign-key this association describes
Set<String>	getTargetKeyPropertyNames()
boolean	hasPartitionedSelectionMapping()
boolean	isFkOptimizationAllowed()
boolean	isReferenceToPrimaryKey()
boolean	isSimpleJoinPredicate(Predicate predicate)	Returns whether the given predicate is a simple join predicate for this attribute.
protected AssociationKey	resolveFetchAssociationKey()

Methods inherited from class org.hibernate.metamodel.mapping.internal.AbstractEntityCollectionPart

buildEagerCollectionFetch, buildEntityFetchJoined, containsTableReference, createDomainResult, createTableGroupInternal, disassemble, findContainingEntityMapping, generateFetch, getAssociatedEntityMappingType, getCollectionDescriptor, getFetchableKey, getFetchableName, getMappedFetchOptions, getMappedType, getNature, getNavigableRole, getNotFoundAction, getNumberOfFetchables, getSqlAliasStem, getStyle, getTiming, incrementFetchDepth, isOptional, isUnwrapProxy, toString

Methods inherited from class java.lang.Object

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

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

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

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

getPartName

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

getAssociatedEntityMappingType, getFetchableName, incrementFetchDepth

Methods inherited from interface org.hibernate.metamodel.mapping.internal.EntityCollectionPart

addToCacheKey, getEntityMappingType, getExpressibleJavaType, getJavaType, getJdbcTypeCount, getPartMappingType

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

applySqlSelections, applySqlSelections, findSubPart, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachSubPart, visitSubParts

Methods inherited from interface org.hibernate.sql.results.graph.Fetchable

asAttributeMapping, getFetchableKey, getMappedFetchOptions, isSelectable, resolveCircularFetch

Methods inherited from interface org.hibernate.sql.results.graph.FetchableContainer

getFetchable, getKeyFetchable, getNumberOfFetchableKeys, getNumberOfKeyFetchables, getSelectableIndex, visitFetchables, visitFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables, visitKeyFetchables

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

areEqual, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, decompose, findContainingEntityMapping, getNavigableRole, isEntityIdentifierMapping, isVirtual

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

findByPath, findByPath, forEachSubPart

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

determineSqlJoinType

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

containsTableReference, getSqlAliasStem

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

forEachNonFormula, forEachSelectable, getJdbcMappings, getSingleJdbcMapping

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

treatAs

Constructor Detail

ManyToManyCollectionPart

public ManyToManyCollectionPart(CollectionPart.Nature nature,
                                Collection collectionBootDescriptor,
                                CollectionPersister collectionDescriptor,
                                EntityMappingType associatedEntityDescriptor,
                                MappingModelCreationProcess creationProcess)

ManyToManyCollectionPart

public ManyToManyCollectionPart(CollectionPart.Nature nature,
                                Collection collectionBootDescriptor,
                                CollectionPersister collectionDescriptor,
                                EntityMappingType associatedEntityDescriptor,
                                NotFoundAction notFoundAction,
                                MappingModelCreationProcess creationProcess)

Method Detail

getCardinality

public EntityCollectionPart.Cardinality getCardinality()

Specified by:

getCardinality in interface EntityCollectionPart

getInclusionCheckPart

public ModelPart getInclusionCheckPart()

Specified by:

getInclusionCheckPart in interface CollectionPart

resolveFetchAssociationKey

protected AssociationKey resolveFetchAssociationKey()

Specified by:

resolveFetchAssociationKey in class AbstractEntityCollectionPart

findSubPart

public ModelPart findSubPart(String name,
                             EntityMappingType targetType)

Specified by:

findSubPart in interface EntityValuedModelPart

Specified by:

findSubPart in interface ModelPartContainer

getTargetKeyPropertyNames

public Set<String> getTargetKeyPropertyNames()

Specified by:

getTargetKeyPropertyNames in interface EntityAssociationMapping

breakDownJdbcValues

public <X,Y> int breakDownJdbcValues(Object domainValue,
                                           int offset,
                                           X x,
                                           Y y,
                                           ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
                                           SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Breaks down the domain value to its constituent JDBC values. Think of it as breaking the multi-dimensional array into a visitable flat array. Additionally, it passes through the values X and Y to the consumer. Returns the amount of jdbc types that have been visited.

Specified by:

breakDownJdbcValues in interface ModelPart

getSelectable

public SelectableMapping getSelectable(int columnIndex)

Description copied from interface: SelectableMappings

Get the selectable at the given position

Specified by:

getSelectable in interface SelectableMappings

getContainingTableExpression

public String getContainingTableExpression()

Description copied from interface: ValuedModelPart

The table which contains the columns mapped by this value

Specified by:

getContainingTableExpression in interface ValuedModelPart

forEachSelectable

public int forEachSelectable(int offset,
                             SelectableConsumer consumer)

Description copied from interface: ModelPart

Visits each selectable mapping with the selectable index offset by the given value. Returns the amount of jdbc types that have been visited.

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

See Also:

SelectableConsumer.accept(int, SelectableMapping)

forEachInsertable

public void forEachInsertable(SelectableConsumer consumer)

Specified by:

forEachInsertable in interface ValuedModelPart

forEachUpdatable

public void forEachUpdatable(SelectableConsumer consumer)

Specified by:

forEachUpdatable in interface ValuedModelPart

decompose

public <X,Y> int decompose(Object domainValue,
                                 int offset,
                                 X x,
                                 Y y,
                                 ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
                                 SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Similar to ModelPart.breakDownJdbcValues(Object, int, Object, Object, JdbcValueBiConsumer, SharedSessionContractImplementor), but this method is supposed to be used for decomposing values for assignment expressions. Returns the amount of jdbc types that have been visited.

Specified by:

decompose in interface ModelPart

getForeignKeyDescriptor

public ForeignKeyDescriptor getForeignKeyDescriptor()

Description copied from interface: Association

The descriptor, allowing access to column(s), etc

Specified by:

getForeignKeyDescriptor in interface Association

getSideNature

public ForeignKeyDescriptor.Nature getSideNature()

Description copied from interface: Association

Indicates which "side" of the foreign-key this association describes

Specified by:

getSideNature in interface Association

getDefaultSqlAstJoinType

public SqlAstJoinType getDefaultSqlAstJoinType(TableGroup parentTableGroup)

Specified by:

getDefaultSqlAstJoinType in interface TableGroupJoinProducer

isSimpleJoinPredicate

public boolean isSimpleJoinPredicate(Predicate predicate)

Description copied from interface: TableGroupJoinProducer

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.

Specified by:

isSimpleJoinPredicate in interface TableGroupJoinProducer

isReferenceToPrimaryKey

public boolean isReferenceToPrimaryKey()

Specified by:

isReferenceToPrimaryKey in interface EntityAssociationMapping

isFkOptimizationAllowed

public boolean isFkOptimizationAllowed()

Specified by:

isFkOptimizationAllowed in interface EntityAssociationMapping

getKeyTargetMatchPart

public ModelPart getKeyTargetMatchPart()

Description copied from interface: EntityAssociationMapping

The model sub-part relative to the associated entity type that is the target of this association's foreign-key

Specified by:

getKeyTargetMatchPart in interface EntityAssociationMapping

createTableGroupJoin

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

Description copied from interface: TableGroupJoinProducer

Create a TableGroupJoin.

Specified by:

createTableGroupJoin in interface TableGroupJoinProducer

Parameters:

navigablePath - The NavigablePath to the join

lhs - The join's (L)eft-(H)and (S)ide

explicitSqlAliasBase - A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState

requestedJoinType - An explicit join-type. May be null to signal that the join is for an implicit path.

addsPredicate - Indicates there are explicit, additional predicates (from an SQM tree ON/WITH clause)

createRootTableGroupJoin

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

Description copied from interface: TableGroupJoinProducer

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.

Specified by:

createRootTableGroupJoin in interface TableGroupJoinProducer

Parameters:

navigablePath - The NavigablePath to the join

lhs - The join's (L)eft-(H)and (S)ide

explicitSqlAliasBase - A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState

requestedJoinType - An explicit join-type. May be null to signal that the join is for an implicit path.

predicateConsumer - Consumer for additional predicates from the producer's mapping.

canUseParentTableGroup

public boolean canUseParentTableGroup(TableGroupProducer producer,
                                      NavigablePath navigablePath,
                                      ValuedModelPart valuedModelPart)

Specified by:

canUseParentTableGroup in interface LazyTableGroup.ParentTableGroupUseChecker

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping in interface ModelPart

finishInitialization

public boolean finishInitialization(CollectionPersister collectionDescriptor,
                                    Collection bootCollectionDescriptor,
                                    String fkTargetModelPartName,
                                    MappingModelCreationProcess creationProcess)

Description copied from interface: EntityCollectionPart

Perform any delayed initialization.

The initialization is considered successful if the result is true. It is considered unsuccessful if the result is false or an exception is thrown. Unsuccessful initializations are generally retried "later", to allow waiting for model-parts being available e.g.

If the exception is something that will just never succeed, consider throwing an exception with the NonTransientException marker to allow the creation process to stop immediately

Specified by:

finishInitialization in interface EntityCollectionPart

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface JdbcMappingContainer