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) 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<?, ?, @Nullable ?>> The treats associated with this SqmFrombooleanbooleanhasJoins()default booleandefault booleanisDeepCompatible(SqmFrom<?, ?> object) <E> SqmBagJoin<R, E> join(CollectionAttribute<? super R, E> attribute) <E> SqmBagJoin<R, E> join(CollectionAttribute<? super R, E> attribute, JoinType jt) <E> SqmListJoin<R, E> join(ListAttribute<? super R, E> list) <E> SqmListJoin<R, E> join(ListAttribute<? super R, E> list, JoinType jt) <K,V> SqmMapJoin <R, K, V> join(MapAttribute<? super R, K, V> map) <K,V> SqmMapJoin <R, K, V> join(MapAttribute<? super R, K, V> map, JoinType jt) <E> SqmSetJoin<R, E> join(SetAttribute<? super R, E> set) <E> SqmSetJoin<R, E> join(SetAttribute<? super R, E> set, JoinType jt) <A> SqmSingularJoin<R, A> join(SingularAttribute<? super R, A> attribute) <A> SqmSingularJoin<R, A> join(SingularAttribute<? super R, A> attribute, JoinType jt) <Y> SqmEntityJoin<R, Y> <Y> SqmEntityJoin<R, Y> <X,Y> SqmAttributeJoin <X, Y> <X,Y> SqmAttributeJoin <X, Y> <X,Y> SqmBagJoin <X, Y> joinCollection(String attributeName) <X,Y> SqmBagJoin <X, Y> joinCollection(String attributeName, JoinType jt) <X,Y> SqmListJoin <X, Y> <X,Y> SqmListJoin <X, Y> <X,K, V> SqmMapJoin <X, K, V> <X,K, V> SqmMapJoin <X, K, V> <X,Y> SqmSetJoin <X, Y> <X,Y> SqmSetJoin <X, Y> 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, @Nullable String alias) voidvisitSqmJoins(Consumer<SqmJoin<R, ?>> consumer) Visit all associated joinsMethods inherited from interface From
getJoins, isCorrelatedMethods 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, join, join, join, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinLateral, joinLateral, joinLateral, joinLateral, joinLateralMethods inherited from interface JpaPath
getParentPathMethods inherited from interface JpaSelection
alias, getCompoundSelectionItems, getSelectionItemsMethods inherited from interface JpaTupleElement
getJavaType, 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
SqmPathSource<R> 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
List<SqmTreatedFrom<?, ?, @Nullable ?>> getSqmTreats()The treats associated with this SqmFrom -
hasTreats
default boolean hasTreats() -
treatAs
-
treatAs
Description copied from interface:JpaPathSupport for JPA's explicit (TREAT) down-casting. -
treatAs
-
treatAs
<S extends R> SqmTreatedFrom<L,R, treatAsS> (EntityDomainType<S> treatTarget, @Nullable String alias) -
deepEquals
-
isDeepCompatible
-
areDeepEqual
-
areDeepCompatible
-
getCorrelationParent
-
join
-
join
-
hasImplicitlySelectableJoin
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
joinCollection
- Specified by:
joinCollectionin interfaceFrom<L,R> - Specified by:
joinCollectionin interfaceJpaFrom<L,R>
-
joinCollection
- Specified by:
joinCollectionin interfaceFrom<L,R> - Specified by:
joinCollectionin interfaceJpaFrom<L,R>
-
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>
-