Class AbstractSqmFrom<O,T>

java.lang.Object

org.hibernate.query.sqm.tree.spi.AbstractSqmNode

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

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

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

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

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

All Implemented Interfaces:

Expression<T>, FetchParent<O,T>, From<O,T>, Path<T>, Selection<T>, TupleElement<T>, Serializable, JpaCriteriaNode, JpaExpression<T>, JpaFetchParent<O,T>, JpaFrom<O,T>, JpaPath<T>, JpaSelection<T>, JpaTupleElement<T>, SemanticPathPart, SqmPath<T>, SqmExpression<T>, SqmFrom<O,T>, SqmSelectableNode<T>, SqmCacheable, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

Direct Known Subclasses:

AbstractSqmJoin, SqmCrossJoin, SqmRoot

public abstract class AbstractSqmFrom<O,T>
extends AbstractSqmPath<T>
implements SqmFrom<O,T>

Convenience base class for SqmFrom implementations

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSqmFrom(EntityDomainType<T> entityType, String alias, NodeBuilder nodeBuilder)	Intended for use with SqmRoot
protected	AbstractSqmFrom(NavigablePath navigablePath, SqmPathSource<T> entityType, String alias, NodeBuilder nodeBuilder)	Intended for use with SqmTreatedRoot to SqmRoot
protected	AbstractSqmFrom(NavigablePath navigablePath, SqmPathSource<T> referencedNavigable, NodeBuilder nodeBuilder)	Intended for use with SqmCorrelatedRootJoin through SqmRoot
protected	AbstractSqmFrom(NavigablePath navigablePath, SqmPathSource<T> referencedNavigable, SqmFrom<?,?> lhs, String alias, NodeBuilder nodeBuilder)

Method Summary

Modifier and Type	Method	Description
void	addSqmJoin(SqmJoin<T,?> join)	Add an associated join
protected <S extends T, X extends SqmTreatedFrom<O,T,S>> X	addTreat(X treat)
JpaSelection<T>	alias(String name)	Assign an alias to this selection.
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
protected void	copyTo(AbstractSqmFrom<O,T> target, SqmCopyContext context)
abstract SqmCorrelation<O,T>	createCorrelation()
<X> JpaCrossJoin<T,X>	crossJoin(Class<X> entityJavaType)	Create a cross join to the given entity type.
<X> JpaCrossJoin<T,X>	crossJoin(EntityDomainType<X> entity)	Create a cross join to the given entity type.
boolean	deepEquals(SqmFrom<?,?> object)
<A> SqmAttributeJoin<T,A>	fetch(PluralAttribute<? super T, ?, A> attribute)	Create a fetch for the given attribute.
<A> SqmAttributeJoin<T,A>	fetch(PluralAttribute<? super T, ?, A> attribute, JoinType jt)	Create a fetch for the given attribute.
<A> SqmSingularJoin<T,A>	fetch(SingularAttribute<? super T, A> attribute)	Create a fetch for the given attribute.
<A> SqmSingularJoin<T,A>	fetch(SingularAttribute<? super T, A> attribute, JoinType jt)	Create a fetch for the given attribute.
<A> SqmAttributeJoin<T,A>	fetch(String attributeName)	Create a fetch for the given attribute.
<A> SqmAttributeJoin<T,A>	fetch(String attributeName, JoinType jt)	Create a fetch for the given attribute.
protected <S extends T> SqmTreatedFrom<O,T,S>	findTreat(ManagedDomainType<S> targetType, String alias)
SqmFrom<O,T>	getCorrelationParent()	Return the correlation parent of this from element.
String	getExplicitAlias()	Retrieve the explicit alias, if one.
Set<Fetch<T,?>>	getFetches()	Return the fetches defined for this fetch parent.
List<Join<T,?>>	getJoinList()
Set<Join<T,?>>	getJoins()
int	getNumberOfJoins()
JpaPath<?>	getParentPath()	Return the parent path.
List<SqmJoin<T,?>>	getSqmJoins()	The joins associated with this SqmFrom
List<SqmTreatedFrom<O,T,?>>	getSqmTreats()	The treats associated with this SqmFrom
boolean	hasImplicitlySelectableJoin()
boolean	hasJoins()
JpaExpression<?>	id()	Create an expression for the identifier of this from element.
boolean	isCorrelated()
boolean	isDeepCompatible(SqmFrom<?,?> object)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery)	Create a derived join for the given subquery.
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, JoinType joinType)	Create a derived join for the given subquery.
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, JoinType joinType, boolean lateral)	Create a derived join for the given subquery.
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, SqmJoinType joinType)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, SqmJoinType joinType, boolean lateral)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, SqmJoinType joinType, boolean lateral, String alias)
<A> SqmBagJoin<T,A>	join(CollectionAttribute<? super T, A> attribute)	Create a collection join to the given attribute.
<E> SqmBagJoin<T,E>	join(CollectionAttribute<? super T, E> attribute, JoinType jt)	Create a collection join to the given attribute.
<R> SqmEntityJoin<T,R>	join(EntityType<R> entityType)	Create an entity join.
<Y> SqmEntityJoin<T,Y>	join(EntityType<Y> entity, JoinType joinType)	Create an entity join.
<E> SqmListJoin<T,E>	join(ListAttribute<? super T, E> attribute)	Create a list join to the given attribute.
<E> SqmListJoin<T,E>	join(ListAttribute<? super T, E> attribute, JoinType jt)	Create a list join to the given attribute.
<K,V> SqmMapJoin<T,K,V>	join(MapAttribute<? super T, K, V> attribute)	Create a map join to the given attribute.
<K,V> SqmMapJoin<T,K,V>	join(MapAttribute<? super T, K, V> attribute, JoinType jt)	Create a map join to the given attribute.
<E> SqmSetJoin<T,E>	join(SetAttribute<? super T, E> attribute)	Create a set join to the given attribute.
<E> SqmSetJoin<T,E>	join(SetAttribute<? super T, E> attribute, JoinType jt)	Create a set join to the given attribute.
<A> SqmSingularJoin<T,A>	join(SingularAttribute<? super T, A> attribute)	Create a join to the given singular attribute.
<A> SqmSingularJoin<T,A>	join(SingularAttribute<? super T, A> attribute, JoinType jt)	Create a join to the given singular attribute.
<R> SqmEntityJoin<T,R>	join(Class<R> entityJavaType)	Create an entity join.
<X> JpaEntityJoin<T,X>	join(Class<X> entityJavaType, JoinType joinType)	Create an entity join.
<X> SqmEntityJoin<T,X>	join(Class<X> targetEntityClass, SqmJoinType joinType)
<Y> SqmEntityJoin<T,Y>	join(Class<Y> entityJavaType, JoinType joinType)	Create an entity join.
<Y> SqmAttributeJoin<T,Y>	join(String attributeName)	Create a join to the named attribute.
<Y> SqmAttributeJoin<T,Y>	join(String attributeName, JoinType jt)	Create a join to the named attribute.
<X> SqmEntityJoin<T,X>	join(EntityDomainType<X> targetEntityDescriptor)	Create an entity join.
<X> JpaEntityJoin<T,X>	join(EntityDomainType<X> entity, JoinType joinType)	Create an entity join.
<X> SqmJoin<?,X>	join(JpaCteCriteria<X> cte)	Create a join to the given CTE.
<X> JpaJoin<?,X>	join(JpaCteCriteria<X> cte, JoinType joinType)	Create a join to the given CTE.
<X> SqmJoin<?,X>	join(JpaCteCriteria<X> cte, SqmJoinType joinType)
<X> SqmJoin<?,X>	join(JpaCteCriteria<X> cte, SqmJoinType joinType, String alias)
<X> JpaFunctionJoin<X>	join(JpaSetReturningFunction<X> function)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	join(JpaSetReturningFunction<X> function, SqmJoinType joinType)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType, boolean) passing false for the lateral parameter.
<X> JpaFunctionJoin<X>	join(JpaSetReturningFunction<X> function, SqmJoinType joinType, boolean lateral)	Creates and returns a join node for the given set returning function.
<X> JpaFunctionJoin<X>	joinArray(SingularAttribute<? super T, X[]> arrayAttribute)	Like calling the overload JpaFrom.joinArray(SingularAttribute, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArray(SingularAttribute<? super T, X[]> arrayAttribute, SqmJoinType joinType)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestArray(Expression) with the given attribute.
<X> JpaFunctionJoin<X>	joinArray(String arrayAttributeName)	Like calling the overload JpaFrom.joinArray(String, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArray(String arrayAttributeName, SqmJoinType joinType)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestArray(Expression) with the result of JpaPath.get(String) passing the given attribute name.
<X> JpaFunctionJoin<X>	joinArrayCollection(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute)	Like calling the overload JpaFrom.joinArrayCollection(SingularAttribute, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArrayCollection(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute, SqmJoinType joinType)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestCollection(Expression) with the given attribute.
<X> JpaFunctionJoin<X>	joinArrayCollection(String collectionAttributeName)	Like calling the overload JpaFrom.joinArrayCollection(String, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArrayCollection(String collectionAttributeName, SqmJoinType joinType)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestCollection(Expression) with the result of JpaPath.get(String) passing the given attribute name.
<Y> SqmBagJoin<T,Y>	joinCollection(String attributeName)	Create a collection join to the named attribute.
<Y> SqmBagJoin<T,Y>	joinCollection(String attributeName, JoinType jt)	Create a collection join to the named attribute.
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery)	Create a lateral derived join for the given subquery.
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery, JoinType joinType)	Create a lateral derived join for the given subquery.
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery, SqmJoinType joinType)
<X> JpaFunctionJoin<X>	joinLateral(JpaSetReturningFunction<X> function)	Like calling the overload JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinLateral(JpaSetReturningFunction<X> function, SqmJoinType joinType)	Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType, boolean) passing true for the lateral parameter.
<Y> SqmListJoin<T,Y>	joinList(String attributeName)	Create a list join to the named attribute.
<Y> SqmListJoin<T,Y>	joinList(String attributeName, JoinType jt)	Create a list join to the named attribute.
<K,V> SqmMapJoin<T,K,V>	joinMap(String attributeName)	Create a map join to the named attribute.
<K,V> SqmMapJoin<T,K,V>	joinMap(String attributeName, JoinType jt)	Create a map join to the named attribute.
<Y> SqmSetJoin<T,Y>	joinSet(String attributeName)	Create a set join to the named attribute.
<Y> SqmSetJoin<T,Y>	joinSet(String attributeName, JoinType jt)	Create a set join to the named attribute.
void	removeLeftFetchJoins()
SqmPath<?>	resolvePathPart(String name, boolean isTerminal, SqmCreationState creationState)
void	setExplicitAlias(String explicitAlias)	Set the explicit alias for this path
<S extends T> SqmTreatedFrom<O,T,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmTreatedFrom<O,T,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends T> SqmTreatedFrom<O,T,S>	treatAs(Class<S> treatJavaType, String alias, boolean fetch)
<S extends T> SqmTreatedFrom<O,T,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmTreatedFrom<O,T,S>	treatAs(EntityDomainType<S> treatTarget, String alias)
void	visitSqmJoins(Consumer<SqmJoin<T,?>> consumer)	Visit all associated joins

Methods inherited from class AbstractSqmPath

cacheHashCode, copyTo, equals, get, get, get, get, get, get, get, get, get, get, getExpressible, getJavaTypeDescriptor, getLhs, getModel, getNavigablePath, getNavigablePathCopy, getNodeJavaType, getNodeType, getReferencedPathSource, getResolvedModel, getReusablePath, getReusablePaths, getTreatedPath, hashCode, isCompatible, registerReusablePath, resolvePath, resolvePath, toString, treatAs, type, visitReusablePaths

Methods inherited from class AbstractSqmExpression

applyInferableType, as, cast, coalesce, coalesce, count, countDistinct, equalTo, equalTo, in, in, in, in, in, internalApplyInferableType, isMember, isNotMember, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo, nullif, nullif, selectCase, selectCase

Methods inherited from class AbstractJpaSelection

getSelectionItems, isCompoundSelection

Methods inherited from class AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface JpaExpression

coalesce, coalesce, count, countDistinct, in, isMember, isNotMember, nullif, nullif, selectCase, selectCase

Methods inherited from interface JpaFrom

treat

Methods inherited from interface JpaSelection

getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeIfKnown, getJavaTypeName, isEnum

Methods inherited from interface Path

get, get, get, get, get, getModel

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface SqmCacheable

cacheHashCode, isCompatible

Methods inherited from interface SqmExpression

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

Methods inherited from interface SqmFrom

copy, getReferencedPathSource, hasTreats, resolveAlias

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmPath

applyInferableType, findRoot, get, get, get, get, get, getJavaTypeDescriptor, getLhs, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveIndexedAccess, treatAs, type, visitReusablePaths

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

accept, toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

AbstractSqmFrom

protected AbstractSqmFrom(@Nonnull
 NavigablePath navigablePath,
 @Nonnull
 SqmPathSource<T> referencedNavigable,
 @Nonnull
 SqmFrom<?,?> lhs,
 @Nullable
 String alias,
 @Nonnull
 NodeBuilder nodeBuilder)

AbstractSqmFrom

protected AbstractSqmFrom(@Nonnull
 EntityDomainType<T> entityType,
 @Nullable
 String alias,
 @Nonnull
 NodeBuilder nodeBuilder)

Intended for use with SqmRoot

AbstractSqmFrom

protected AbstractSqmFrom(@Nonnull
 NavigablePath navigablePath,
 @Nonnull
 SqmPathSource<T> entityType,
 @Nullable
 String alias,
 @Nonnull
 NodeBuilder nodeBuilder)

Intended for use with SqmTreatedRoot to SqmRoot

AbstractSqmFrom

protected AbstractSqmFrom(@Nonnull
 NavigablePath navigablePath,
 @Nonnull
 SqmPathSource<T> referencedNavigable,
 @Nonnull
 NodeBuilder nodeBuilder)

Intended for use with SqmCorrelatedRootJoin through SqmRoot

Method Details

copyTo

protected void copyTo(@Nonnull
 AbstractSqmFrom<O,T> target,
 @Nonnull
 SqmCopyContext context)

getExplicitAlias

@Nullable
public String getExplicitAlias()

Description copied from interface: SqmPath

Retrieve the explicit alias, if one. May return null

Specified by:

getExplicitAlias in interface SqmPath<O>

Overrides:

getExplicitAlias in class AbstractSqmPath<T>

setExplicitAlias

public void setExplicitAlias(@Nullable
 String explicitAlias)

Description copied from interface: SqmPath

Set the explicit alias for this path

Specified by:

setExplicitAlias in interface SqmPath<O>

Overrides:

setExplicitAlias in class AbstractSqmPath<T>

resolvePathPart

@Nonnull
public SqmPath<?> resolvePathPart(@Nonnull
 String name,
 boolean isTerminal,
 @Nonnull
 SqmCreationState creationState)

Specified by:

resolvePathPart in interface SemanticPathPart

Specified by:

resolvePathPart in interface SqmPath<O>

getJoinList

@Nonnull
public List<Join<T,?>> getJoinList()

Specified by:

getJoinList in interface From<O,T>

hasJoins

public boolean hasJoins()

Specified by:

hasJoins in interface SqmFrom<O,T>

getSqmJoins

@Nonnull
public List<SqmJoin<T,?>> getSqmJoins()

Description copied from interface: SqmFrom

The joins associated with this SqmFrom

Specified by:

getSqmJoins in interface SqmFrom<O,T>

getNumberOfJoins

public int getNumberOfJoins()

Specified by:

getNumberOfJoins in interface SqmFrom<O,T>

addSqmJoin

public void addSqmJoin(@Nonnull
 SqmJoin<T,?> join)

Description copied from interface: SqmFrom

Add an associated join

Specified by:

addSqmJoin in interface SqmFrom<O,T>

removeLeftFetchJoins

@Internal
public void removeLeftFetchJoins()

visitSqmJoins

public void visitSqmJoins(@Nonnull
 Consumer<SqmJoin<T,?>> consumer)

Description copied from interface: SqmFrom

Visit all associated joins

Specified by:

visitSqmJoins in interface SqmFrom<O,T>

getSqmTreats

@Nonnull
public List<SqmTreatedFrom<O,T,?>> getSqmTreats()

Description copied from interface: SqmFrom

The treats associated with this SqmFrom

Specified by:

getSqmTreats in interface SqmFrom<O,T>

findTreat

@Nullable
protected <S extends T> SqmTreatedFrom<O,T,S> findTreat(@Nonnull
 ManagedDomainType<S> targetType,
 @Nullable
 String alias)

addTreat

@Nonnull
protected <S extends T, X extends SqmTreatedFrom<O,T,S>>
X addTreat(@Nonnull
 X treat)

getParentPath

@Nullable
public JpaPath<?> getParentPath()

Description copied from interface: JpaPath

Return the parent path.

Specified by:

getParentPath in interface JpaPath<O>

Specified by:

getParentPath in interface Path<O>

getCorrelationParent

@Nonnull
public SqmFrom<O,T> getCorrelationParent()

Description copied from interface: JpaFrom

Return the correlation parent of this from element.

Specified by:

getCorrelationParent in interface From<O,T>

Specified by:

getCorrelationParent in interface JpaFrom<O,T>

Specified by:

getCorrelationParent in interface SqmFrom<O,T>

createCorrelation

@Nonnull
public abstract SqmCorrelation<O,T> createCorrelation()

isCorrelated

public boolean isCorrelated()

Specified by:

isCorrelated in interface From<O,T>

getJoins

@Nonnull
public Set<Join<T,?>> getJoins()

Specified by:

getJoins in interface From<O,T>

hasImplicitlySelectableJoin

public boolean hasImplicitlySelectableJoin()

Specified by:

hasImplicitlySelectableJoin in interface SqmFrom<O,T>

join

@Nonnull
public <A> SqmSingularJoin<T,A> join(@Nonnull
 SingularAttribute<? super T, A> attribute)

Description copied from interface: JpaFrom

Create a join to the given singular attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <A> SqmSingularJoin<T,A> join(@Nonnull
 SingularAttribute<? super T, A> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a join to the given singular attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <X> SqmEntityJoin<T,X> join(@Nonnull
 Class<X> targetEntityClass,
 @Nonnull
 SqmJoinType joinType)

join

@Nonnull
public <X> SqmEntityJoin<T,X> join(@Nonnull
 EntityDomainType<X> targetEntityDescriptor)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <A> SqmBagJoin<T,A> join(@Nonnull
 CollectionAttribute<? super T, A> attribute)

Description copied from interface: JpaFrom

Create a collection join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <E> SqmBagJoin<T,E> join(@Nonnull
 CollectionAttribute<? super T, E> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a collection join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <E> SqmSetJoin<T,E> join(@Nonnull
 SetAttribute<? super T, E> attribute)

Description copied from interface: JpaFrom

Create a set join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <E> SqmSetJoin<T,E> join(@Nonnull
 SetAttribute<? super T, E> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a set join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <E> SqmListJoin<T,E> join(@Nonnull
 ListAttribute<? super T, E> attribute)

Description copied from interface: JpaFrom

Create a list join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <E> SqmListJoin<T,E> join(@Nonnull
 ListAttribute<? super T, E> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a list join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <K,V> SqmMapJoin<T,K,V> join(@Nonnull
 MapAttribute<? super T, K, V> attribute)

Description copied from interface: JpaFrom

Create a map join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <K,V> SqmMapJoin<T,K,V> join(@Nonnull
 MapAttribute<? super T, K, V> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a map join to the given attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <Y> SqmAttributeJoin<T,Y> join(@Nonnull
 String attributeName)

Description copied from interface: JpaFrom

Create a join to the named attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <Y> SqmAttributeJoin<T,Y> join(@Nonnull
 String attributeName,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a join to the named attribute.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <X> JpaEntityJoin<T,X> join(@Nonnull
 Class<X> entityJavaType,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <X> JpaEntityJoin<T,X> join(@Nonnull
 EntityDomainType<X> entity,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <X> JpaDerivedJoin<X> join(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create a derived join for the given subquery.

Specified by:

join in interface JpaFrom<O,T>

joinLateral

@Nonnull
public <X> JpaDerivedJoin<X> joinLateral(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create a lateral derived join for the given subquery.

Specified by:

joinLateral in interface JpaFrom<O,T>

join

@Nonnull
public <X> JpaDerivedJoin<X> join(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 JoinType joinType,
 boolean lateral)

Description copied from interface: JpaFrom

Create a derived join for the given subquery.

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <X> JpaJoin<?,X> join(@Nonnull
 JpaCteCriteria<X> cte,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create a join to the given CTE.

Specified by:

join in interface JpaFrom<O,T>

joinCollection

@Nonnull
public <Y> SqmBagJoin<T,Y> joinCollection(@Nonnull
 String attributeName)

Description copied from interface: JpaFrom

Create a collection join to the named attribute.

Specified by:

joinCollection in interface From<O,T>

Specified by:

joinCollection in interface JpaFrom<O,T>

Specified by:

joinCollection in interface SqmFrom<O,T>

joinCollection

@Nonnull
public <Y> SqmBagJoin<T,Y> joinCollection(@Nonnull
 String attributeName,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a collection join to the named attribute.

Specified by:

joinCollection in interface From<O,T>

Specified by:

joinCollection in interface JpaFrom<O,T>

Specified by:

joinCollection in interface SqmFrom<O,T>

joinSet

@Nonnull
public <Y> SqmSetJoin<T,Y> joinSet(@Nonnull
 String attributeName)

Description copied from interface: JpaFrom

Create a set join to the named attribute.

Specified by:

joinSet in interface From<O,T>

Specified by:

joinSet in interface JpaFrom<O,T>

Specified by:

joinSet in interface SqmFrom<O,T>

joinSet

@Nonnull
public <Y> SqmSetJoin<T,Y> joinSet(@Nonnull
 String attributeName,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a set join to the named attribute.

Specified by:

joinSet in interface From<O,T>

Specified by:

joinSet in interface JpaFrom<O,T>

Specified by:

joinSet in interface SqmFrom<O,T>

joinList

@Nonnull
public <Y> SqmListJoin<T,Y> joinList(@Nonnull
 String attributeName)

Description copied from interface: JpaFrom

Create a list join to the named attribute.

Specified by:

joinList in interface From<O,T>

Specified by:

joinList in interface JpaFrom<O,T>

Specified by:

joinList in interface SqmFrom<O,T>

joinList

@Nonnull
public <Y> SqmListJoin<T,Y> joinList(@Nonnull
 String attributeName,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a list join to the named attribute.

Specified by:

joinList in interface From<O,T>

Specified by:

joinList in interface JpaFrom<O,T>

Specified by:

joinList in interface SqmFrom<O,T>

joinMap

@Nonnull
public <K,V> SqmMapJoin<T,K,V> joinMap(@Nonnull
 String attributeName)

Description copied from interface: JpaFrom

Create a map join to the named attribute.

Specified by:

joinMap in interface From<O,T>

Specified by:

joinMap in interface JpaFrom<O,T>

Specified by:

joinMap in interface SqmFrom<O,T>

joinMap

@Nonnull
public <K,V> SqmMapJoin<T,K,V> joinMap(@Nonnull
 String attributeName,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFrom

Create a map join to the named attribute.

Specified by:

joinMap in interface From<O,T>

Specified by:

joinMap in interface JpaFrom<O,T>

Specified by:

joinMap in interface SqmFrom<O,T>

join

@Nonnull
public <R> SqmEntityJoin<T,R> join(@Nonnull
 Class<R> entityJavaType)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <R> SqmEntityJoin<T,R> join(@Nonnull
 EntityType<R> entityType)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <Y> SqmEntityJoin<T,Y> join(@Nonnull
 Class<Y> entityJavaType,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

Specified by:

join in interface SqmFrom<O,T>

join

@Nonnull
public <Y> SqmEntityJoin<T,Y> join(@Nonnull
 EntityType<Y> entity,
 @Nonnull
 JoinType joinType)

Description copied from interface: JpaFrom

Create an entity join.

Specified by:

join in interface From<O,T>

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <X> JpaDerivedJoin<X> join(@Nonnull
 Subquery<X> subquery)

Description copied from interface: JpaFrom

Create a derived join for the given subquery.

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <X> JpaDerivedJoin<X> join(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 SqmJoinType joinType)

joinLateral

@Nonnull
public <X> JpaDerivedJoin<X> joinLateral(@Nonnull
 Subquery<X> subquery)

Description copied from interface: JpaFrom

Create a lateral derived join for the given subquery.

Specified by:

joinLateral in interface JpaFrom<O,T>

joinLateral

@Nonnull
public <X> JpaDerivedJoin<X> joinLateral(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 SqmJoinType joinType)

join

@Nonnull
public <X> JpaDerivedJoin<X> join(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 SqmJoinType joinType,
 boolean lateral)

join

@Nonnull
public <X> JpaDerivedJoin<X> join(@Nonnull
 Subquery<X> subquery,
 @Nonnull
 SqmJoinType joinType,
 boolean lateral,
 @Nullable
 String alias)

join

@Nonnull
public <X> SqmJoin<?,X> join(@Nonnull
 JpaCteCriteria<X> cte)

Description copied from interface: JpaFrom

Create a join to the given CTE.

Specified by:

join in interface JpaFrom<O,T>

join

@Nonnull
public <X> SqmJoin<?,X> join(@Nonnull
 JpaCteCriteria<X> cte,
 @Nonnull
 SqmJoinType joinType)

join

@Nonnull
public <X> SqmJoin<?,X> join(@Nonnull
 JpaCteCriteria<X> cte,
 @Nonnull
 SqmJoinType joinType,
 @Nullable
 String alias)

joinLateral

@Nonnull
public <X> JpaFunctionJoin<X> joinLateral(@Nonnull
 JpaSetReturningFunction<X> function,
 @Nonnull
 SqmJoinType joinType)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType, boolean) passing true for the lateral parameter.

Specified by:

joinLateral in interface JpaFrom<O,T>

See Also:

• JpaFrom.join(JpaSetReturningFunction, SqmJoinType, boolean)

joinLateral

@Nonnull
public <X> JpaFunctionJoin<X> joinLateral(@Nonnull
 JpaSetReturningFunction<X> function)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType) with SqmJoinType.INNER.

Specified by:

joinLateral in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType)

join

@Nonnull
public <X> JpaFunctionJoin<X> join(@Nonnull
 JpaSetReturningFunction<X> function,
 @Nonnull
 SqmJoinType joinType)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType, boolean) passing false for the lateral parameter.

Specified by:

join in interface JpaFrom<O,T>

See Also:

• JpaFrom.join(JpaSetReturningFunction, SqmJoinType, boolean)

join

@Nonnull
public <X> JpaFunctionJoin<X> join(@Nonnull
 JpaSetReturningFunction<X> function)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with SqmJoinType.INNER.

Specified by:

join in interface JpaFrom<O,T>

See Also:

• JpaFrom.join(JpaSetReturningFunction, SqmJoinType)

join

@Nonnull
public <X> JpaFunctionJoin<X> join(@Nonnull
 JpaSetReturningFunction<X> function,
 @Nonnull
 SqmJoinType joinType,
 boolean lateral)

Description copied from interface: JpaFrom

Creates and returns a join node for the given set returning function. If function arguments refer to correlated paths, the lateral argument must be set to true. Failing to do so when necessary may lead to an error during query compilation or execution.

Specified by:

join in interface JpaFrom<O,T>

joinArray

@Nonnull
public <X> JpaFunctionJoin<X> joinArray(@Nonnull
 String arrayAttributeName)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.joinArray(String, SqmJoinType) with SqmJoinType.INNER.

Specified by:

joinArray in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinArray(String, SqmJoinType)

joinArray

@Nonnull
public <X> JpaFunctionJoin<X> joinArray(@Nonnull
 String arrayAttributeName,
 @Nonnull
 SqmJoinType joinType)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestArray(Expression) with the result of JpaPath.get(String) passing the given attribute name.

Specified by:

joinArray in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType)

joinArray

@Nonnull
public <X> JpaFunctionJoin<X> joinArray(@Nonnull
 SingularAttribute<? super T, X[]> arrayAttribute)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.joinArray(SingularAttribute, SqmJoinType) with SqmJoinType.INNER.

Specified by:

joinArray in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinArray(SingularAttribute, SqmJoinType)

joinArray

@Nonnull
public <X> JpaFunctionJoin<X> joinArray(@Nonnull
 SingularAttribute<? super T, X[]> arrayAttribute,
 @Nonnull
 SqmJoinType joinType)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestArray(Expression) with the given attribute.

Specified by:

joinArray in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType)

joinArrayCollection

@Nonnull
public <X> JpaFunctionJoin<X> joinArrayCollection(@Nonnull
 String collectionAttributeName)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.joinArrayCollection(String, SqmJoinType) with SqmJoinType.INNER.

Specified by:

joinArrayCollection in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinArrayCollection(String, SqmJoinType)

joinArrayCollection

@Nonnull
public <X> JpaFunctionJoin<X> joinArrayCollection(@Nonnull
 String collectionAttributeName,
 @Nonnull
 SqmJoinType joinType)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestCollection(Expression) with the result of JpaPath.get(String) passing the given attribute name.

Specified by:

joinArrayCollection in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType)

joinArrayCollection

@Nonnull
public <X> JpaFunctionJoin<X> joinArrayCollection(@Nonnull
 SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.joinArrayCollection(SingularAttribute, SqmJoinType) with SqmJoinType.INNER.

Specified by:

joinArrayCollection in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinArrayCollection(SingularAttribute, SqmJoinType)

joinArrayCollection

@Nonnull
public <X> JpaFunctionJoin<X> joinArrayCollection(@Nonnull
 SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute,
 @Nonnull
 SqmJoinType joinType)

Description copied from interface: JpaFrom

Like calling the overload JpaFrom.join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestCollection(Expression) with the given attribute.

Specified by:

joinArrayCollection in interface JpaFrom<O,T>

See Also:

• JpaFrom.joinLateral(JpaSetReturningFunction, SqmJoinType)

crossJoin

@Nonnull
public <X> JpaCrossJoin<T,X> crossJoin(@Nonnull
 Class<X> entityJavaType)

Description copied from interface: JpaFrom

Create a cross join to the given entity type.

Specified by:

crossJoin in interface JpaFrom<O,T>

crossJoin

@Nonnull
public <X> JpaCrossJoin<T,X> crossJoin(@Nonnull
 EntityDomainType<X> entity)

Description copied from interface: JpaFrom

Create a cross join to the given entity type.

Specified by:

crossJoin in interface JpaFrom<O,T>

getFetches

@Nonnull
public Set<Fetch<T,?>> getFetches()

Description copied from interface: JpaFetchParent

Return the fetches defined for this fetch parent.

Specified by:

getFetches in interface FetchParent<O,T>

Specified by:

getFetches in interface JpaFetchParent<O,T>

fetch

@Nonnull
public <A> SqmSingularJoin<T,A> fetch(@Nonnull
 SingularAttribute<? super T, A> attribute)

Description copied from interface: JpaFetchParent

Create a fetch for the given attribute.

Specified by:

fetch in interface FetchParent<O,T>

Specified by:

fetch in interface JpaFetchParent<O,T>

fetch

@Nonnull
public <A> SqmSingularJoin<T,A> fetch(@Nonnull
 SingularAttribute<? super T, A> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFetchParent

Create a fetch for the given attribute.

Specified by:

fetch in interface FetchParent<O,T>

Specified by:

fetch in interface JpaFetchParent<O,T>

fetch

@Nonnull
public <A> SqmAttributeJoin<T,A> fetch(@Nonnull
 PluralAttribute<? super T, ?, A> attribute)

Description copied from interface: JpaFetchParent

Create a fetch for the given attribute.

Specified by:

fetch in interface FetchParent<O,T>

Specified by:

fetch in interface JpaFetchParent<O,T>

fetch

@Nonnull
public <A> SqmAttributeJoin<T,A> fetch(@Nonnull
 PluralAttribute<? super T, ?, A> attribute,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFetchParent

Create a fetch for the given attribute.

Specified by:

fetch in interface FetchParent<O,T>

Specified by:

fetch in interface JpaFetchParent<O,T>

fetch

@Nonnull
public <A> SqmAttributeJoin<T,A> fetch(@Nonnull
 String attributeName)

Description copied from interface: JpaFetchParent

Create a fetch for the given attribute.

Specified by:

fetch in interface FetchParent<O,T>

Specified by:

fetch in interface JpaFetchParent<O,T>

fetch

@Nonnull
public <A> SqmAttributeJoin<T,A> fetch(@Nonnull
 String attributeName,
 @Nonnull
 JoinType jt)

Description copied from interface: JpaFetchParent

Create a fetch for the given attribute.

Specified by:

fetch in interface FetchParent<O,T>

Specified by:

fetch in interface JpaFetchParent<O,T>

treatAs

@Nonnull
public <S extends T> SqmTreatedFrom<O,T,S> treatAs(@Nonnull
 Class<S> treatJavaType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaFrom<O,T>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmPath<O>

Overrides:

treatAs in class AbstractSqmPath<T>

treatAs

@Nonnull
public <S extends T> SqmTreatedFrom<O,T,S> treatAs(@Nonnull
 EntityDomainType<S> treatTarget)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaFrom<O,T>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmPath<O>

Overrides:

treatAs in class AbstractSqmPath<T>

treatAs

@Nonnull
public <S extends T> SqmTreatedFrom<O,T,S> treatAs(@Nonnull
 Class<S> treatJavaType,
 @Nullable
 String alias)

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmPath<O>

Overrides:

treatAs in class AbstractSqmPath<T>

treatAs

@Nonnull
public <S extends T> SqmTreatedFrom<O,T,S> treatAs(@Nonnull
 EntityDomainType<S> treatTarget,
 @Nullable
 String alias)

Specified by:

treatAs in interface SqmFrom<O,T>

Specified by:

treatAs in interface SqmPath<O>

Overrides:

treatAs in class AbstractSqmPath<T>

treatAs

@Nonnull
public <S extends T> SqmTreatedFrom<O,T,S> treatAs(@Nonnull
 Class<S> treatJavaType,
 @Nullable
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<O>

Overrides:

treatAs in class AbstractSqmPath<T>

appendHqlString

public void appendHqlString(@Nonnull
 StringBuilder hql,
 @Nonnull
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

alias

@Nonnull
public JpaSelection<T> alias(@Nonnull
 String name)

Description copied from interface: JpaSelection

Assign an alias to this selection.

Specified by:

alias in interface JpaSelection<O>

Specified by:

alias in interface Selection<O>

Overrides:

alias in class AbstractJpaSelection<T>

id

@Nonnull
public JpaExpression<?> id()

Description copied from interface: JpaFrom

Create an expression for the identifier of this from element.

Specified by:

id in interface JpaFrom<O,T>

deepEquals

public boolean deepEquals(@Nonnull
 SqmFrom<?,?> object)

Specified by:

deepEquals in interface SqmFrom<O,T>

isDeepCompatible

public boolean isDeepCompatible(@Nonnull
 SqmFrom<?,?> object)

Specified by:

isDeepCompatible in interface SqmFrom<O,T>