Package org.hibernate.query.sqm.tree.from

Interface SqmFrom<O,T>

All Superinterfaces:

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

All Known Subinterfaces:

JpaDerivedJoin<T>, SqmAttributeJoin<O,T>, SqmCorrelation<O,T>, SqmJoin<O,T>, SqmQualifiedJoin<O,T>

All Known Implementing Classes:

AbstractSqmAttributeJoin, AbstractSqmFrom, AbstractSqmJoin, AbstractSqmPluralJoin, SqmBagJoin, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmDerivedJoin, SqmDerivedRoot, SqmEntityJoin, SqmListJoin, SqmMapJoin, SqmPluralPartJoin, SqmRoot, SqmSetJoin, SqmSingularJoin, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEntityJoin, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSingularJoin

public interface SqmFrom<O,T>
extends SqmVisitableNode, SqmPath<T>, JpaFrom<O,T>

Models a Bindable's inclusion in the FROM clause.

Field Summary

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

log

Method Summary

Modifier and Type	Method	Description
void	addSqmJoin(SqmJoin<T,?> join)	Add an associated join
SqmFrom<O,T>	copy(SqmCopyContext context)
SqmFrom<O,T>	getCorrelationParent()
SqmPathSource<T>	getReferencedPathSource()	The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).
List<SqmJoin<T,?>>	getSqmJoins()	The joins associated with this SqmFrom
List<SqmFrom<?,?>>	getSqmTreats()	The treats associated with this SqmFrom
boolean	hasJoins()
boolean	hasTreats()
<E> SqmBagJoin<T,E>	join(jakarta.persistence.metamodel.CollectionAttribute<? super T,E> attribute)
<E> SqmBagJoin<T,E>	join(jakarta.persistence.metamodel.CollectionAttribute<? super T,E> attribute, jakarta.persistence.criteria.JoinType jt)
<E> SqmListJoin<T,E>	join(jakarta.persistence.metamodel.ListAttribute<? super T,E> list)
<E> SqmListJoin<T,E>	join(jakarta.persistence.metamodel.ListAttribute<? super T,E> list, jakarta.persistence.criteria.JoinType jt)
<K,V> SqmMapJoin<T,K,V>	join(jakarta.persistence.metamodel.MapAttribute<? super T,K,V> map)
<K,V> SqmMapJoin<T,K,V>	join(jakarta.persistence.metamodel.MapAttribute<? super T,K,V> map, jakarta.persistence.criteria.JoinType jt)
<E> SqmSetJoin<T,E>	join(jakarta.persistence.metamodel.SetAttribute<? super T,E> set)
<E> SqmSetJoin<T,E>	join(jakarta.persistence.metamodel.SetAttribute<? super T,E> set, jakarta.persistence.criteria.JoinType jt)
<A> SqmSingularJoin<T,A>	join(jakarta.persistence.metamodel.SingularAttribute<? super T,A> attribute)
<A> SqmSingularJoin<T,A>	join(jakarta.persistence.metamodel.SingularAttribute<? super T,A> attribute, jakarta.persistence.criteria.JoinType jt)
<X,Y> SqmAttributeJoin<X,Y>	join(String attributeName)
<X,Y> SqmAttributeJoin<X,Y>	join(String attributeName, jakarta.persistence.criteria.JoinType jt)
<X,Y> jakarta.persistence.criteria.CollectionJoin<X,Y>	joinCollection(String attributeName)
<X,Y> SqmBagJoin<X,Y>	joinCollection(String attributeName, jakarta.persistence.criteria.JoinType jt)
<X,Y> jakarta.persistence.criteria.ListJoin<X,Y>	joinList(String attributeName)
<X,Y> SqmListJoin<X,Y>	joinList(String attributeName, jakarta.persistence.criteria.JoinType jt)
<X,K,V> jakarta.persistence.criteria.MapJoin<X,K,V>	joinMap(String attributeName)
<X,K,V> SqmMapJoin<X,K,V>	joinMap(String attributeName, jakarta.persistence.criteria.JoinType jt)
<X,Y> jakarta.persistence.criteria.SetJoin<X,Y>	joinSet(String attributeName)
<X,Y> SqmSetJoin<X,Y>	joinSet(String attributeName, jakarta.persistence.criteria.JoinType jt)
<S extends T> SqmFrom<?,S>	treatAs(Class<S> treatAsType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmFrom<?,S>	treatAs(Class<S> treatJavaType, String alias)
<S extends T> SqmFrom<?,S>	treatAs(EntityDomainType<S> treatAsType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> SqmFrom<?,S>	treatAs(EntityDomainType<S> treatTarget, String alias)
void	visitSqmJoins(Consumer<SqmJoin<T,?>> consumer)	Visit all associated joins

Methods inherited from interface jakarta.persistence.criteria.From

getJoins, isCorrelated

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

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

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

join, join, join, join, join, join, join, joinLateral, joinLateral

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.Path

getModel

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

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.SqmNode

asLoggableText, nodeBuilder

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

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

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

getExpressible, getNodeJavaType

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

accept, appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Method Detail

getReferencedPathSource

SqmPathSource<T> getReferencedPathSource()

The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).

Specified by:

getReferencedPathSource in interface SqmPath<O>

Returns:

See Also:

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

hasJoins

boolean hasJoins()

getSqmJoins

List<SqmJoin<T,?>> getSqmJoins()

The joins associated with this SqmFrom

addSqmJoin

void addSqmJoin(SqmJoin<T,?> join)

Add an associated join

visitSqmJoins

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

Visit all associated joins

treatAs

<S extends T> SqmFrom<?,S> treatAs(Class<S> treatAsType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmFrom<?,S> treatAs(EntityDomainType<S> treatAsType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface SqmPath<O>

treatAs

<S extends T> SqmFrom<?,S> treatAs(Class<S> treatJavaType,
                                         String alias)

treatAs

<S extends T> SqmFrom<?,S> treatAs(EntityDomainType<S> treatTarget,
                                         String alias)

hasTreats

boolean hasTreats()

getSqmTreats

List<SqmFrom<?,?>> getSqmTreats()

The treats associated with this SqmFrom

getCorrelationParent

SqmFrom<O,T> getCorrelationParent()

Specified by:

getCorrelationParent in interface jakarta.persistence.criteria.From<O,T>

Specified by:

getCorrelationParent in interface JpaFrom<O,T>

join

<A> SqmSingularJoin<T,A> join(jakarta.persistence.metamodel.SingularAttribute<? super T,A> attribute)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<A> SqmSingularJoin<T,A> join(jakarta.persistence.metamodel.SingularAttribute<? super T,A> attribute,
                                    jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<E> SqmBagJoin<T,E> join(jakarta.persistence.metamodel.CollectionAttribute<? super T,E> attribute)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<E> SqmBagJoin<T,E> join(jakarta.persistence.metamodel.CollectionAttribute<? super T,E> attribute,
                               jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<E> SqmSetJoin<T,E> join(jakarta.persistence.metamodel.SetAttribute<? super T,E> set)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<E> SqmSetJoin<T,E> join(jakarta.persistence.metamodel.SetAttribute<? super T,E> set,
                               jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<E> SqmListJoin<T,E> join(jakarta.persistence.metamodel.ListAttribute<? super T,E> list)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<E> SqmListJoin<T,E> join(jakarta.persistence.metamodel.ListAttribute<? super T,E> list,
                                jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<K,V> SqmMapJoin<T,K,V> join(jakarta.persistence.metamodel.MapAttribute<? super T,K,V> map)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<K,V> SqmMapJoin<T,K,V> join(jakarta.persistence.metamodel.MapAttribute<? super T,K,V> map,
                                               jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<X,Y> SqmAttributeJoin<X,Y> join(String attributeName)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

join

<X,Y> SqmAttributeJoin<X,Y> join(String attributeName,
                                             jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<O,T>

joinCollection

<X,Y> jakarta.persistence.criteria.CollectionJoin<X,Y> joinCollection(String attributeName)

Specified by:

joinCollection in interface jakarta.persistence.criteria.From<O,T>

joinCollection

<X,Y> SqmBagJoin<X,Y> joinCollection(String attributeName,
                                                 jakarta.persistence.criteria.JoinType jt)

Specified by:

joinCollection in interface jakarta.persistence.criteria.From<O,T>

joinSet

<X,Y> jakarta.persistence.criteria.SetJoin<X,Y> joinSet(String attributeName)

Specified by:

joinSet in interface jakarta.persistence.criteria.From<O,T>

joinSet

<X,Y> SqmSetJoin<X,Y> joinSet(String attributeName,
                                          jakarta.persistence.criteria.JoinType jt)

Specified by:

joinSet in interface jakarta.persistence.criteria.From<O,T>

joinList

<X,Y> jakarta.persistence.criteria.ListJoin<X,Y> joinList(String attributeName)

Specified by:

joinList in interface jakarta.persistence.criteria.From<O,T>

joinList

<X,Y> SqmListJoin<X,Y> joinList(String attributeName,
                                            jakarta.persistence.criteria.JoinType jt)

Specified by:

joinList in interface jakarta.persistence.criteria.From<O,T>

joinMap

<X,K,V> jakarta.persistence.criteria.MapJoin<X,K,V> joinMap(String attributeName)

Specified by:

joinMap in interface jakarta.persistence.criteria.From<O,T>

joinMap

<X,K,V> SqmMapJoin<X,K,V> joinMap(String attributeName,
                                                          jakarta.persistence.criteria.JoinType jt)

Specified by:

joinMap in interface jakarta.persistence.criteria.From<O,T>

copy

SqmFrom<O,T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<O>

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>