Package org.hibernate.query.sqm.tree.domain

Class SqmMapJoin<O,K,V>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement<T>

org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection<T>

org.hibernate.query.sqm.tree.expression.AbstractSqmExpression<T>

org.hibernate.query.sqm.tree.domain.AbstractSqmPath<T>

org.hibernate.query.sqm.tree.domain.AbstractSqmFrom<O,T>

org.hibernate.query.sqm.tree.domain.AbstractSqmJoin<O,T>

org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin<O,T>

org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin<O,E>

org.hibernate.query.sqm.tree.domain.AbstractSqmPluralJoin<O,Map<K,V>,V>

org.hibernate.query.sqm.tree.domain.SqmMapJoin<O,K,V>

All Implemented Interfaces:

jakarta.persistence.criteria.Expression<V>, jakarta.persistence.criteria.Fetch<O,V>, jakarta.persistence.criteria.FetchParent<O,V>, jakarta.persistence.criteria.From<O,V>, jakarta.persistence.criteria.Join<O,V>, jakarta.persistence.criteria.MapJoin<O,K,V>, jakarta.persistence.criteria.Path<V>, jakarta.persistence.criteria.PluralJoin<O,Map<K,V>,V>, jakarta.persistence.criteria.Selection<V>, jakarta.persistence.TupleElement<V>, Serializable, JpaCriteriaNode, JpaExpression<V>, JpaFetch<O,V>, JpaFetchParent<O,V>, JpaFrom<O,V>, JpaJoin<O,V>, JpaJoinedFrom<O,V>, JpaMapJoin<O,K,V>, JpaPath<V>, JpaPluralJoin<O,Map<K,V>,V>, JpaSelection<V>, JpaTupleElement<V>, SemanticPathPart, SqmPath<V>, SqmExpression<V>, SqmAttributeJoin<O,V>, SqmFrom<O,V>, SqmJoin<O,V>, SqmQualifiedJoin<O,V>, SqmSelectableNode<V>, SqmExpressibleAccessor<V>, SqmNode, SqmTypedNode<V>, SqmVisitableNode

Direct Known Subclasses:

SqmCorrelatedMapJoin, SqmTreatedMapJoin

public class SqmMapJoin<O,K,V>
extends AbstractSqmPluralJoin<O,Map<K,V>,V>
implements JpaMapJoin<O,K,V>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.sqm.tree.from.SqmAttributeJoin

SqmAttributeJoin.NotJoinableException

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqmMapJoin(SqmFrom<?,O> lhs, MapPersistentAttribute<O,K,V> pluralValuedNavigable, String alias, SqmJoinType sqmJoinType, boolean fetched, NodeBuilder nodeBuilder)
protected	SqmMapJoin(SqmFrom<?,O> lhs, NavigablePath navigablePath, MapPersistentAttribute<O,K,V> pluralValuedNavigable, String alias, SqmJoinType joinType, boolean fetched, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
SqmMapJoin<O,K,V>	copy(SqmCopyContext context)
SqmCorrelatedMapJoin<O,K,V>	createCorrelation()
jakarta.persistence.criteria.Expression<Map.Entry<K,V>>	entry()
MapPersistentAttribute<O,K,V>	getAttribute()
MapPersistentAttribute<O,K,V>	getModel()
MapPersistentAttribute<O,K,V>	getReferencedPathSource()	The path source that this path refers to (and that most likely created it).
SqmPath<K>	key()
SqmMapJoin<O,K,V>	makeCopy(SqmCreationProcessingState creationProcessingState)
SqmMapJoin<O,K,V>	on(jakarta.persistence.criteria.Expression<Boolean> restriction)
SqmMapJoin<O,K,V>	on(jakarta.persistence.criteria.Predicate... restrictions)
SqmMapJoin<O,K,V>	on(JpaExpression<Boolean> restriction)	Add a restriction to the fetch.
SqmMapJoin<O,K,V>	on(JpaPredicate... restrictions)	Add a restriction to the fetch.
<S extends V> SqmTreatedMapJoin<O,K,V,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends V> SqmTreatedMapJoin<O,K,V,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends V> SqmTreatedMapJoin<O,K,V,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends V> SqmTreatedMapJoin<O,K,V,S>	treatAs(EntityDomainType<S> treatTarget, String alias)
jakarta.persistence.criteria.Path<V>	value()

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin

accept, getJoinType, getLhs, getNodeJavaType, getParent, isFetched

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmQualifiedJoin

applyRestriction, copyTo, getJoinPredicate, getOn, setJoinPredicate

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmJoin

getSqmJoinType

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmFrom

addSqmJoin, addTreat, alias, appendHqlString, copyTo, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoins, getParentPath, getSqmJoins, getSqmTreats, hasJoins, hasTreats, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinLateral, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet, resolvePathPart, setExplicitAlias, visitSqmJoins

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmPath

copyTo, get, get, get, get, getNavigablePath, getNodeType, getReusablePath, getReusablePaths, registerReusablePath, resolvePath, resolvePath, toString, type, visitReusablePaths

Methods inherited from class org.hibernate.query.sqm.tree.expression.AbstractSqmExpression

applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection

getSelectionItems, isCompoundSelection

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.persistence.criteria.From

getJoins, isCorrelated

Methods inherited from interface jakarta.persistence.criteria.Join

getJoinType, getOn, getParent

Methods inherited from interface org.hibernate.query.criteria.JpaFetch

fetch, fetch, fetch, fetch, fetch, fetch, getFetches

Methods inherited from interface org.hibernate.query.criteria.JpaFrom

crossJoin, crossJoin, join, join, join, join, join, join, join, join, join, joinLateral, joinLateral

Methods inherited from interface org.hibernate.query.criteria.JpaJoinedFrom

getOn

Methods inherited from interface org.hibernate.query.criteria.JpaPath

getParentPath

Methods inherited from interface org.hibernate.query.criteria.JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement

getJavaType

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

Methods inherited from interface org.hibernate.query.sqm.tree.from.SqmAttributeJoin

getJavaTypeDescriptor, getJoinPredicate, setJoinPredicate

Methods inherited from interface org.hibernate.query.sqm.tree.expression.SqmExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, castAs, in, in, in, in, isNotNull, isNull, visitSubSelectableNodes

Methods inherited from interface org.hibernate.query.sqm.tree.from.SqmFrom

addSqmJoin, getCorrelationParent, getSqmJoins, getSqmTreats, hasJoins, hasTreats, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet, visitSqmJoins

Methods inherited from interface org.hibernate.query.sqm.tree.from.SqmJoin

getSqmJoinType, join, join

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.domain.SqmPath

applyInferableType, findRoot, get, get, get, get, getExplicitAlias, getNavigablePath, getNodeType, getReusablePath, getReusablePaths, registerReusablePath, resolveAlias, resolveIndexedAccess, resolvePathPart, setExplicitAlias, type, visitReusablePaths

Methods inherited from interface org.hibernate.query.sqm.tree.SqmTypedNode

getExpressible

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode

appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Detail

SqmMapJoin

public SqmMapJoin(SqmFrom<?,O> lhs,
                  MapPersistentAttribute<O,K,V> pluralValuedNavigable,
                  String alias,
                  SqmJoinType sqmJoinType,
                  boolean fetched,
                  NodeBuilder nodeBuilder)

SqmMapJoin

protected SqmMapJoin(SqmFrom<?,O> lhs,
                     NavigablePath navigablePath,
                     MapPersistentAttribute<O,K,V> pluralValuedNavigable,
                     String alias,
                     SqmJoinType joinType,
                     boolean fetched,
                     NodeBuilder nodeBuilder)

Method Detail

copy

public SqmMapJoin<O,K,V> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<O>

Specified by:

copy in interface SqmFrom<O,K>

Specified by:

copy in interface SqmJoin<O,K>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<O>

Specified by:

copy in interface SqmSelectableNode<O>

Specified by:

copy in interface SqmTypedNode<O>

getReferencedPathSource

public MapPersistentAttribute<O,K,V> getReferencedPathSource()

Description copied from interface: SqmPath

The path source that this path refers to (and that most likely created it).

Specified by:

getReferencedPathSource in interface SqmAttributeJoin<O,K>

Specified by:

getReferencedPathSource in interface SqmFrom<O,K>

Specified by:

getReferencedPathSource in interface SqmPath<O>

Overrides:

getReferencedPathSource in class AbstractSqmPluralJoin<O,Map<K,V>,V>

See Also:

SqmPathSource.createSqmPath(org.hibernate.query.sqm.tree.domain.SqmPath<?>, org.hibernate.query.sqm.SqmPathSource<?>)

getModel

public MapPersistentAttribute<O,K,V> getModel()

Specified by:

getModel in interface jakarta.persistence.criteria.MapJoin<O,K,V>

Specified by:

getModel in interface jakarta.persistence.criteria.Path<O>

Specified by:

getModel in interface jakarta.persistence.criteria.PluralJoin<O,K,V>

Overrides:

getModel in class AbstractSqmPluralJoin<O,Map<K,V>,V>

getAttribute

public MapPersistentAttribute<O,K,V> getAttribute()

Specified by:

getAttribute in interface jakarta.persistence.criteria.Fetch<O,K>

Specified by:

getAttribute in interface jakarta.persistence.criteria.Join<O,K>

Specified by:

getAttribute in interface JpaJoin<O,K>

Specified by:

getAttribute in interface JpaPluralJoin<O,K,V>

Overrides:

getAttribute in class AbstractSqmAttributeJoin<O,V>

key

public SqmPath<K> key()

Specified by:

key in interface jakarta.persistence.criteria.MapJoin<O,K,V>

value

public jakarta.persistence.criteria.Path<V> value()

Specified by:

value in interface jakarta.persistence.criteria.MapJoin<O,K,V>

entry

public jakarta.persistence.criteria.Expression<Map.Entry<K,V>> entry()

Specified by:

entry in interface jakarta.persistence.criteria.MapJoin<O,K,V>

on

public SqmMapJoin<O,K,V> on(JpaExpression<Boolean> restriction)

Description copied from interface: JpaFetch

Add a restriction to the fetch.

Specified by:

on in interface JpaFetch<O,K>

Specified by:

on in interface JpaJoin<O,K>

Specified by:

on in interface JpaJoinedFrom<O,K>

Specified by:

on in interface JpaMapJoin<O,K,V>

Specified by:

on in interface JpaPluralJoin<O,K,V>

Overrides:

on in class AbstractSqmAttributeJoin<O,V>

on

public SqmMapJoin<O,K,V> on(jakarta.persistence.criteria.Expression<Boolean> restriction)

Specified by:

on in interface jakarta.persistence.criteria.Join<O,K>

Specified by:

on in interface JpaJoin<O,K>

Specified by:

on in interface JpaJoinedFrom<O,K>

Specified by:

on in interface JpaMapJoin<O,K,V>

Specified by:

on in interface JpaPluralJoin<O,K,V>

Specified by:

on in interface jakarta.persistence.criteria.MapJoin<O,K,V>

Overrides:

on in class AbstractSqmAttributeJoin<O,V>

on

public SqmMapJoin<O,K,V> on(JpaPredicate... restrictions)

Description copied from interface: JpaFetch

Add a restriction to the fetch.

Specified by:

on in interface JpaFetch<O,K>

Specified by:

on in interface JpaJoin<O,K>

Specified by:

on in interface JpaJoinedFrom<O,K>

Specified by:

on in interface JpaMapJoin<O,K,V>

Specified by:

on in interface JpaPluralJoin<O,K,V>

Overrides:

on in class AbstractSqmAttributeJoin<O,V>

on

public SqmMapJoin<O,K,V> on(jakarta.persistence.criteria.Predicate... restrictions)

Specified by:

on in interface jakarta.persistence.criteria.Join<O,K>

Specified by:

on in interface JpaJoin<O,K>

Specified by:

on in interface JpaJoinedFrom<O,K>

Specified by:

on in interface JpaMapJoin<O,K,V>

Specified by:

on in interface JpaPluralJoin<O,K,V>

Specified by:

on in interface jakarta.persistence.criteria.MapJoin<O,K,V>

Overrides:

on in class AbstractSqmAttributeJoin<O,V>

createCorrelation

public SqmCorrelatedMapJoin<O,K,V> createCorrelation()

Specified by:

createCorrelation in class AbstractSqmFrom<O,V>

treatAs

public <S extends V> SqmTreatedMapJoin<O,K,V,S> treatAs(Class<S> treatJavaType)

Description copied from interface: JpaPath

Support for JPA's explicit (TREAT) down-casting.

Specified by:

treatAs in interface JpaJoin<O,K>

Specified by:

treatAs in interface JpaMapJoin<O,K,V>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface JpaPluralJoin<O,K,V>

Specified by:

treatAs in interface SqmAttributeJoin<O,K>

Specified by:

treatAs in interface SqmFrom<O,K>

Specified by:

treatAs in interface SqmPath<O>

treatAs

public <S extends V> SqmTreatedMapJoin<O,K,V,S> treatAs(EntityDomainType<S> treatTarget)

Description copied from interface: JpaPath

Support for JPA's explicit (TREAT) down-casting.

Specified by:

treatAs in interface JpaJoin<O,K>

Specified by:

treatAs in interface JpaMapJoin<O,K,V>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface JpaPluralJoin<O,K,V>

Specified by:

treatAs in interface SqmAttributeJoin<O,K>

Specified by:

treatAs in interface SqmFrom<O,K>

Specified by:

treatAs in interface SqmPath<O>

treatAs

public <S extends V> SqmTreatedMapJoin<O,K,V,S> treatAs(Class<S> treatJavaType,
                                                                          String alias)

Specified by:

treatAs in interface SqmFrom<O,K>

treatAs

public <S extends V> SqmTreatedMapJoin<O,K,V,S> treatAs(EntityDomainType<S> treatTarget,
                                                                          String alias)

Specified by:

treatAs in interface SqmFrom<O,K>

makeCopy

public SqmMapJoin<O,K,V> makeCopy(SqmCreationProcessingState creationProcessingState)

Specified by:

makeCopy in interface SqmAttributeJoin<O,K>