Interface SqmFrom<L,R>
- Type Parameters:
L- The from-element's "left hand side". It may be the same asRfor roots.R- The from-element's "right hand side". For joins, this is the target side.
- All Superinterfaces:
Expression<R>, FetchParent<L,R>, From<L, R>, JpaCriteriaNode, JpaExpression<R>, JpaFetchParent<L, R>, JpaFrom<L, R>, JpaPath<R>, JpaSelection<R>, JpaTupleElement<R>, Path<R>, Selection<R>, SemanticPathPart, Serializable, SqmCacheable, SqmExpressibleAccessor<R>, SqmExpression<R>, SqmNode, SqmPath<R>, SqmSelectableNode<R>, SqmTypedNode<R>, SqmVisitableNode, TupleElement<R>
- All Known Subinterfaces:
SqmAttributeJoin<O,T>, SqmCorrelatedJoin<L, R>, SqmCorrelatedSingularValuedJoin<L, R>, SqmCorrelation<L, R>, SqmJoin<L, R>, SqmSingularValuedJoin<L, R>, SqmTreatedAttributeJoin<L, R, R1>, SqmTreatedFrom<L, R, R1>, SqmTreatedJoin<L, R, R1>
- All Known Implementing Classes:
AbstractSqmAttributeJoin, AbstractSqmFrom, AbstractSqmJoin, AbstractSqmPluralJoin, SqmBagJoin, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedCteJoin, SqmCorrelatedDerivedJoin, SqmCorrelatedDerivedRoot, SqmCorrelatedDerivedRootJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmCteJoin, SqmCteRoot, SqmDerivedJoin, SqmDerivedRoot, SqmEntityJoin, SqmFunctionJoin, SqmFunctionRoot, SqmListJoin, SqmMapJoin, SqmPluralPartJoin, SqmRoot, SqmSetJoin, SqmSingularJoin, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEntityJoin, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSingularJoin
Models a SqmPathSource's inclusion in the
FROM clause.-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddSqmJoin(SqmJoin<R, ?> join) Add an associated joinstatic booleanareDeepCompatible(List<? extends SqmFrom<?, ?>> theseFroms, List<? extends SqmFrom<?, ?>> thoseFroms) static booleanareDeepEqual(List<? extends SqmFrom<?, ?>> theseFroms, List<? extends SqmFrom<?, ?>> thoseFroms) copy(SqmCopyContext context) default booleandeepEquals(SqmFrom<?, ?> object) Return the correlation parent of this from element.intThe Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).The joins associated with this SqmFromList<SqmTreatedFrom<L, R, ?>> The treats associated with this SqmFrombooleanbooleanhasJoins()default booleandefault booleanisDeepCompatible(SqmFrom<?, ?> object) <E> SqmBagJoin<R, E> join(CollectionAttribute<? super R, E> attribute) Create a collection join to the given attribute.<E> SqmBagJoin<R, E> join(CollectionAttribute<? super R, E> attribute, JoinType jt) Create a collection join to the given attribute.<E> SqmListJoin<R, E> join(ListAttribute<? super R, E> list) Create a list join to the given attribute.<E> SqmListJoin<R, E> join(ListAttribute<? super R, E> list, JoinType jt) Create a list join to the given attribute.<K,V> SqmMapJoin <R, K, V> join(MapAttribute<? super R, K, V> map) Create a map join to the given attribute.<K,V> SqmMapJoin <R, K, V> join(MapAttribute<? super R, K, V> map, JoinType jt) Create a map join to the given attribute.<E> SqmSetJoin<R, E> join(SetAttribute<? super R, E> set) Create a set join to the given attribute.<E> SqmSetJoin<R, E> join(SetAttribute<? super R, E> set, JoinType jt) Create a set join to the given attribute.<A> SqmSingularJoin<R, A> join(SingularAttribute<? super R, A> attribute) Create a join to the given singular attribute.<A> SqmSingularJoin<R, A> join(SingularAttribute<? super R, A> attribute, JoinType jt) Create a join to the given singular attribute.<Y> SqmEntityJoin<R, Y> Create an entity join.<Y> SqmEntityJoin<R, Y> Create an entity join.<Y> SqmAttributeJoin<R, Y> Create a join to the named attribute.<Y> SqmAttributeJoin<R, Y> Create a join to the named attribute.<Y> SqmBagJoin<R, Y> joinCollection(String attributeName) Create a collection join to the named attribute.<Y> SqmBagJoin<R, Y> joinCollection(String attributeName, JoinType jt) Create a collection join to the named attribute.<Y> SqmListJoin<R, Y> Create a list join to the named attribute.<Y> SqmListJoin<R, Y> Create a list join to the named attribute.<K,V> SqmMapJoin <R, K, V> Create a map join to the named attribute.<K,V> SqmMapJoin <R, K, V> Create a map join to the named attribute.<Y> SqmSetJoin<R, Y> Create a set join to the named attribute.<Y> SqmSetJoin<R, Y> Create a set join to the named attribute.default StringresolveAlias(SqmRenderContext context) Retrieve the explicit alias, if one, otherwise return a generated one.<S extends R>
SqmTreatedFrom<L, R, S> Support for JPA's explicit (TREAT) down-casting.<S extends R>
SqmTreatedFrom<L, R, S> <S extends R>
SqmTreatedFrom<L, R, S> treatAs(EntityDomainType<S> treatTarget) Support for JPA's explicit (TREAT) down-casting.<S extends R>
SqmTreatedFrom<L, R, S> treatAs(EntityDomainType<S> treatTarget, String alias) voidvisitSqmJoins(Consumer<SqmJoin<R, ?>> consumer) Visit all associated joinsMethods inherited from interface From
getJoinList, getJoins, isCorrelatedMethods inherited from interface JpaExpression
coalesce, coalesce, count, countDistinct, in, isMember, isNotMember, nullif, nullif, selectCase, selectCaseMethods inherited from interface JpaFetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetchesMethods inherited from interface JpaFrom
crossJoin, crossJoin, id, join, join, join, join, join, join, join, join, join, join, join, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinLateral, joinLateral, joinLateral, joinLateral, treatMethods inherited from interface JpaPath
getParentPathMethods inherited from interface JpaSelection
alias, getCompoundSelectionItems, getSelectionItemsMethods inherited from interface JpaTupleElement
getJavaType, getJavaTypeIfKnown, getJavaTypeName, isEnumMethods inherited from interface Selection
isCompoundSelectionMethods inherited from interface SqmCacheable
cacheHashCode, isCompatibleMethods inherited from interface SqmExpression
as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, castAs, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo, visitSubSelectableNodesMethods inherited from interface SqmNode
asLoggableText, nodeBuilderMethods inherited from interface SqmPath
applyInferableType, findRoot, get, get, get, get, get, getExplicitAlias, getJavaTypeDescriptor, getLhs, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveIndexedAccess, resolvePathPart, setExplicitAlias, treatAs, treatAs, type, visitReusablePathsMethods inherited from interface SqmSelectableNode
getTupleLengthMethods inherited from interface SqmTypedNode
getExpressible, getNodeJavaTypeMethods inherited from interface SqmVisitableNode
accept, appendHqlString, toHqlStringMethods inherited from interface TupleElement
getAlias
-
Method Details
-
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:
getReferencedPathSourcein interfaceSqmPath<L>- Returns:
- See Also:
-
resolveAlias
Retrieve the explicit alias, if one, otherwise return a generated one. -
hasJoins
boolean hasJoins() -
getNumberOfJoins
int getNumberOfJoins() -
getSqmJoins
-
addSqmJoin
-
visitSqmJoins
-
getSqmTreats
The treats associated with this SqmFrom -
hasTreats
default boolean hasTreats() -
treatAs
Description copied from interface:JpaPathSupport for JPA's explicit (TREAT) down-casting. -
treatAs
Description copied from interface:JpaPathSupport for JPA's explicit (TREAT) down-casting. -
treatAs
-
treatAs
-
deepEquals
-
isDeepCompatible
-
areDeepEqual
-
areDeepCompatible
-
getCorrelationParent
-
join
-
join
-
hasImplicitlySelectableJoin
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
joinCollection
Description copied from interface:JpaFromCreate a collection join to the named attribute.- Specified by:
joinCollectionin interfaceFrom<L,R> - Specified by:
joinCollectionin interfaceJpaFrom<L,R>
-
joinCollection
-
joinSet
-
joinSet
-
joinList
-
joinList
-
joinMap
-
joinMap
-
copy
- Specified by:
copyin interfaceSqmExpression<L>- Specified by:
copyin interfaceSqmNode- Specified by:
copyin interfaceSqmPath<L>- Specified by:
copyin interfaceSqmSelectableNode<L>- Specified by:
copyin interfaceSqmTypedNode<L>
-