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:

Expression<V>, Fetch<O,V>, FetchParent<O,V>, From<O,V>, Join<O,V>, MapJoin<O,K,V>, Path<V>, PluralJoin<O,Map<K,V>,V>, Selection<V>, 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>

Author:

Steve Ebersole

See Also:

• Serialized Form

Field Summary

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

log

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
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
SqmMapJoin<O,K,V>	copy(SqmCopyContext context)
SqmCorrelatedMapJoin<O,K,V>	createCorrelation()
Expression<Map.Entry<K,V>>	entry()	Create an expression that corresponds to the map entry.
MapPersistentAttribute<O,K,V>	getAttribute()	Return the metamodel attribute corresponding to the fetch join.
MapPersistentAttribute<O,K,V>	getModel()	Return the bindable object that corresponds to the path expression.
SqmPath<K>	key()	Create a path expression that corresponds to the map key.
SqmMapJoin<O,K,V>	makeCopy(SqmCreationProcessingState creationProcessingState)
SqmMapJoin<O,K,V>	on(Expression<Boolean> restriction)	Modify the join to restrict the result according to the specified ON condition and return the join object.
SqmMapJoin<O,K,V>	on(Predicate... restrictions)	Modify the join to restrict the result according to the specified ON condition and return the join object.
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(Class<S> treatJavaType, String alias, boolean fetch)
<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)
<S extends V> SqmTreatedMapJoin<O,K,V,S>	treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetch)
SqmPath<V>	value()	Create a path expression that corresponds to the map value.

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

alias, clearFetched, 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, appendHqlString, copyTo, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoins, getParentPath, getSqmJoins, getSqmTreats, hasJoins, 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, removeLeftFetchJoins, resolvePathPart, setExplicitAlias, visitSqmJoins

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

copyTo, get, get, get, get, getExpressible, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, getResolvedModel, getReusablePath, getReusablePaths, getTreatedPath, 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, equalTo, equalTo, 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, getJavaTypeName, isEnum

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

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

getJavaTypeDescriptor, getJoinPredicate, getReferencedPathSource, isImplicitlySelectable, setJoinPredicate

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

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, castAs, equalTo, equalTo, 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, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveAlias, resolveIndexedAccess, resolvePathPart, setExplicitAlias, type, visitReusablePaths

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectableNode

getTupleLength

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 Details

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 Details

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>

getModel

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

Description copied from interface: Path

Return the bindable object that corresponds to the path expression.

Specified by:

getModel in interface MapJoin<O,K,V>

Specified by:

getModel in interface Path<O>

Specified by:

getModel in interface PluralJoin<O,K,V>

Overrides:

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

Returns:

bindable object corresponding to the path

accept

public <X> X accept(SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

Overrides:

accept in class AbstractSqmAttributeJoin<O,V>

getAttribute

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

Description copied from interface: Fetch

Return the metamodel attribute corresponding to the fetch join.

Specified by:

getAttribute in interface Fetch<O,K>

Specified by:

getAttribute in interface 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>

Returns:

metamodel attribute for the join

key

public SqmPath<K> key()

Description copied from interface: MapJoin

Create a path expression that corresponds to the map key.

Specified by:

key in interface MapJoin<O,K,V>

Returns:

path corresponding to map key

value

public SqmPath<V> value()

Description copied from interface: MapJoin

Create a path expression that corresponds to the map value. This method is for stylistic use only: it just returns this.

Specified by:

value in interface MapJoin<O,K,V>

Returns:

path corresponding to the map value

entry

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

Description copied from interface: MapJoin

Create an expression that corresponds to the map entry.

Specified by:

entry in interface MapJoin<O,K,V>

Returns:

expression corresponding to the map entry

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(Expression<Boolean> restriction)

Description copied from interface: Join

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Specified by:

on in interface 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 MapJoin<O,K,V>

Overrides:

on in class AbstractSqmAttributeJoin<O,V>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified join object

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(Predicate... restrictions)

Description copied from interface: Join

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Specified by:

on in interface 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 MapJoin<O,K,V>

Overrides:

on in class AbstractSqmAttributeJoin<O,V>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified join object

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 SqmAttributeJoin<O,K>

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 SqmAttributeJoin<O,K>

Specified by:

treatAs in interface SqmFrom<O,K>

treatAs

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

Specified by:

treatAs in interface SqmAttributeJoin<O,K>

treatAs

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

Specified by:

treatAs in interface SqmAttributeJoin<O,K>

makeCopy

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

Specified by:

makeCopy in interface SqmAttributeJoin<O,K>