Package org.hibernate.query.criteria
Interface JpaFrom<O,T>
- All Superinterfaces:
Expression<T>
,FetchParent<O,
,T> From<O,
,T> JpaCriteriaNode
,JpaExpression<T>
,JpaFetchParent<O,
,T> JpaPath<T>
,JpaSelection<T>
,JpaTupleElement<T>
,Path<T>
,Selection<T>
,Serializable
,TupleElement<T>
- All Known Subinterfaces:
JpaCollectionJoin<O,
,T> JpaCrossJoin<T>
,JpaDerivedFrom<T>
,JpaDerivedJoin<T>
,JpaDerivedRoot<T>
,JpaEntityJoin<L,
,R> JpaFunctionFrom<O,
,T> JpaFunctionJoin<E>
,JpaFunctionRoot<E>
,JpaJoin<L,
,R> JpaListJoin<O,
,T> JpaMapJoin<O,
,K, V> JpaPluralJoin<O,
,C, E> JpaRoot<T>
,JpaSetJoin<O,
,T> JpaTreatedFrom<L,
,R, R1> JpaTreatedJoin<L,
,R, R1> SqmAttributeJoin<O,
,T> SqmCorrelatedJoin<L,
,R> SqmCorrelatedSingularValuedJoin<L,
,R> SqmCorrelation<L,
,R> SqmFrom<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
,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
API extension to the JPA
From
contract-
Method Summary
Modifier and TypeMethodDescription<X> JpaCrossJoin<X>
<X> JpaCrossJoin<X>
crossJoin
(EntityDomainType<X> entity) <X> JpaDerivedJoin<X>
default <X> JpaDerivedJoin<X>
default <X> JpaDerivedJoin<X>
<X> JpaDerivedJoin<X>
join
(Subquery<X> subquery, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.<X> JpaDerivedJoin<X>
join
(Subquery<X> subquery, SqmJoinType joinType, boolean lateral) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API.<Y> JpaCollectionJoin<T,
Y> join
(CollectionAttribute<? super T, Y> collection) <Y> JpaCollectionJoin<T,
Y> join
(CollectionAttribute<? super T, Y> collection, JoinType jt) join
(EntityType<Y> entity) join
(EntityType<Y> entity, JoinType joinType) <Y> JpaListJoin<T,
Y> join
(ListAttribute<? super T, Y> list) <Y> JpaListJoin<T,
Y> join
(ListAttribute<? super T, Y> list, JoinType jt) <K,
V> JpaMapJoin<T, K, V> join
(MapAttribute<? super T, K, V> map) <K,
V> JpaMapJoin<T, K, V> join
(MapAttribute<? super T, K, V> map, JoinType jt) <Y> JpaSetJoin<T,
Y> join
(SetAttribute<? super T, Y> set) <Y> JpaSetJoin<T,
Y> join
(SetAttribute<? super T, Y> set, JoinType jt) join
(SingularAttribute<? super T, Y> attribute) join
(SingularAttribute<? super T, Y> attribute, JoinType jt) default <X> JpaEntityJoin<T,
X> default <X> JpaEntityJoin<T,
X> join
(Class<X> entityJavaType, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API.<Y> JpaEntityJoin<T,
Y> <Y> JpaEntityJoin<T,
Y> <X,
Y> JpaJoin<X, Y> <X,
Y> JpaJoin<X, Y> <X> JpaEntityJoin<T,
X> join
(EntityDomainType<X> entity) default <X> JpaEntityJoin<T,
X> join
(EntityDomainType<X> entity, JoinType joinType) <X> JpaEntityJoin<T,
X> join
(EntityDomainType<X> entity, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API.<X> JpaJoin<?,
X> join
(JpaCteCriteria<X> cte) default <X> JpaJoin<?,
X> join
(JpaCteCriteria<X> cte, JoinType joinType) <X> JpaJoin<?,
X> join
(JpaCteCriteria<X> cte, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API.<X> JpaFunctionJoin<X>
join
(JpaSetReturningFunction<X> function) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withSqmJoinType.INNER
.<X> JpaFunctionJoin<X>
join
(JpaSetReturningFunction<X> function, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType, boolean)
passingfalse
for thelateral
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 overloadjoinArray(SingularAttribute, SqmJoinType)
withSqmJoinType.INNER
.<X> JpaFunctionJoin<X>
joinArray
(SingularAttribute<? super T, X[]> arrayAttribute, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestArray(Expression)
with the given attribute.<X> JpaFunctionJoin<X>
Like calling the overloadjoinArray(String, SqmJoinType)
withSqmJoinType.INNER
.<X> JpaFunctionJoin<X>
joinArray
(String arrayAttributeName, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestArray(Expression)
with the result ofJpaPath.get(String)
passing the given attribute name.<X> JpaFunctionJoin<X>
joinArrayCollection
(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute) Like calling the overloadjoinArrayCollection(SingularAttribute, SqmJoinType)
withSqmJoinType.INNER
.<X> JpaFunctionJoin<X>
joinArrayCollection
(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestCollection(Expression)
with the given attribute.<X> JpaFunctionJoin<X>
joinArrayCollection
(String collectionAttributeName) Like calling the overloadjoinArrayCollection(String, SqmJoinType)
withSqmJoinType.INNER
.<X> JpaFunctionJoin<X>
joinArrayCollection
(String collectionAttributeName, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestCollection(Expression)
with the result ofJpaPath.get(String)
passing the given attribute name.<X,
Y> JpaCollectionJoin<X, Y> joinCollection
(String attributeName) <X,
Y> JpaCollectionJoin<X, Y> joinCollection
(String attributeName, JoinType jt) <X> JpaDerivedJoin<X>
joinLateral
(Subquery<X> subquery) default <X> JpaDerivedJoin<X>
joinLateral
(Subquery<X> subquery, JoinType joinType) <X> JpaDerivedJoin<X>
joinLateral
(Subquery<X> subquery, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API.<X> JpaFunctionJoin<X>
joinLateral
(JpaSetReturningFunction<X> function) Like calling the overloadjoinLateral(JpaSetReturningFunction, SqmJoinType)
withSqmJoinType.INNER
.<X> JpaFunctionJoin<X>
joinLateral
(JpaSetReturningFunction<X> function, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType, boolean)
passingtrue
for thelateral
parameter.<X,
Y> JpaListJoin<X, Y> <X,
Y> JpaListJoin<X, Y> <X,
K, V> JpaMapJoin<X, K, V> <X,
K, V> JpaMapJoin<X, K, V> <X,
Y> JpaSetJoin<X, Y> <X,
Y> JpaSetJoin<X, Y> <S extends T>
JpaTreatedFrom<O,T, S> Support for JPA's explicit (TREAT) down-casting.<S extends T>
JpaTreatedFrom<O,T, S> treatAs
(EntityDomainType<S> treatJavaType) Support for JPA's explicit (TREAT) down-casting.Methods inherited from interface jakarta.persistence.criteria.From
getJoins, isCorrelated
Methods inherited from interface org.hibernate.query.criteria.JpaExpression
as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo
Methods inherited from interface org.hibernate.query.criteria.JpaFetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches
Methods inherited from interface org.hibernate.query.criteria.JpaPath
get, get, get, get, getLhs, getNavigablePath, getParentPath, type
Methods inherited from interface org.hibernate.query.criteria.JpaSelection
alias, getCompoundSelectionItems, getSelectionItems
Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement
getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum
Methods inherited from interface jakarta.persistence.criteria.Selection
isCompoundSelection
Methods inherited from interface jakarta.persistence.TupleElement
getAlias
-
Method Details
-
getCorrelationParent
- Specified by:
getCorrelationParent
in interfaceFrom<O,
T>
-
join
-
join
-
join
@Deprecated(since="7", forRemoval=true) default <X> JpaEntityJoin<T,X> join(Class<X> entityJavaType, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API. It will be removed. Usejoin(Class, org.hibernate.query.common.JoinType)
-
join
-
join
-
join
-
join
-
join
@Deprecated(since="7", forRemoval=true) <X> JpaEntityJoin<T,X> join(EntityDomainType<X> entity, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API. It will be removed. Usejoin(EntityDomainType, org.hibernate.query.common.JoinType)
-
join
-
join
-
join
@Incubating @Deprecated(since="7", forRemoval=true) <X> JpaDerivedJoin<X> join(Subquery<X> subquery, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API. It will be removed. Usejoin(Subquery, org.hibernate.query.common.JoinType)
-
join
-
joinLateral
-
joinLateral
@Incubating @Deprecated(since="7", forRemoval=true) <X> JpaDerivedJoin<X> joinLateral(Subquery<X> subquery, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API. It will be removed. UsejoinLateral(Subquery, org.hibernate.query.common.JoinType)
-
joinLateral
-
join
@Incubating @Deprecated(since="7", forRemoval=true) <X> JpaDerivedJoin<X> join(Subquery<X> subquery, SqmJoinType joinType, boolean lateral) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API. It will be removed. Usejoin(Subquery, org.hibernate.query.common.JoinType, boolean)
-
join
-
join
Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withSqmJoinType.INNER
.- Since:
- 7.0
- See Also:
-
join
Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType, boolean)
passingfalse
for thelateral
parameter.- Since:
- 7.0
- See Also:
-
joinLateral
Like calling the overloadjoinLateral(JpaSetReturningFunction, SqmJoinType)
withSqmJoinType.INNER
.- Since:
- 7.0
- See Also:
-
joinLateral
@Incubating <X> JpaFunctionJoin<X> joinLateral(JpaSetReturningFunction<X> function, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType, boolean)
passingtrue
for thelateral
parameter.- Since:
- 7.0
- See Also:
-
join
@Incubating <X> JpaFunctionJoin<X> join(JpaSetReturningFunction<X> function, SqmJoinType joinType, boolean lateral) Creates and returns a join node for the given set returning function. If function arguments refer to correlated paths, thelateral
argument must be set totrue
. Failing to do so when necessary may lead to an error during query compilation or execution.- Since:
- 7.0
-
joinArray
Like calling the overloadjoinArray(String, SqmJoinType)
withSqmJoinType.INNER
.- Since:
- 7.0
- See Also:
-
joinArray
Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestArray(Expression)
with the result ofJpaPath.get(String)
passing the given attribute name.- Since:
- 7.0
- See Also:
-
joinArray
Like calling the overloadjoinArray(SingularAttribute, SqmJoinType)
withSqmJoinType.INNER
.- Since:
- 7.0
- See Also:
-
joinArray
@Incubating <X> JpaFunctionJoin<X> joinArray(SingularAttribute<? super T, X[]> arrayAttribute, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestArray(Expression)
with the given attribute.- Since:
- 7.0
- See Also:
-
joinArrayCollection
Like calling the overloadjoinArrayCollection(String, SqmJoinType)
withSqmJoinType.INNER
.- Since:
- 7.0
- See Also:
-
joinArrayCollection
@Incubating <X> JpaFunctionJoin<X> joinArrayCollection(String collectionAttributeName, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestCollection(Expression)
with the result ofJpaPath.get(String)
passing the given attribute name.- Since:
- 7.0
- See Also:
-
joinArrayCollection
@Incubating <X> JpaFunctionJoin<X> joinArrayCollection(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute) Like calling the overloadjoinArrayCollection(SingularAttribute, SqmJoinType)
withSqmJoinType.INNER
.- Since:
- 7.0
- See Also:
-
joinArrayCollection
@Incubating <X> JpaFunctionJoin<X> joinArrayCollection(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute, SqmJoinType joinType) Like calling the overloadjoin(JpaSetReturningFunction, SqmJoinType)
withHibernateCriteriaBuilder.unnestCollection(Expression)
with the given attribute.- Since:
- 7.0
- See Also:
-
join
-
join
@Incubating @Deprecated(since="7", forRemoval=true) <X> JpaJoin<?,X> join(JpaCteCriteria<X> cte, SqmJoinType joinType) Deprecated, for removal: This API element is subject to removal in a future version.This method is a layer-breaker, leaking the SQM typeSqmJoinType
onto an API. It will be removed. Usejoin(JpaCteCriteria, org.hibernate.query.common.JoinType)
-
join
-
crossJoin
-
crossJoin
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
join
-
joinCollection
- Specified by:
joinCollection
in interfaceFrom<O,
T>
-
joinSet
-
joinList
-
joinMap
-
join
-
joinCollection
- Specified by:
joinCollection
in interfaceFrom<O,
T>
-
joinSet
-
joinList
-
joinMap
-
treatAs
Description copied from interface:JpaPath
Support for JPA's explicit (TREAT) down-casting. -
treatAs
Description copied from interface:JpaPath
Support for JPA's explicit (TREAT) down-casting.
-
SqmJoinType
onto an API.