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<L,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, 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

public interface JpaFrom<O,T>
extends JpaPath<T>, JpaFetchParent<O,T>, From<O,T>

API extension to the JPA From contract

Method Summary

Modifier and Type	Method	Description
<X> JpaCrossJoin<T,X>	crossJoin(Class<X> entityJavaType)
<X> JpaCrossJoin<T,X>	crossJoin(EntityDomainType<X> entity)
JpaFrom<O,T>	getCorrelationParent()
JpaExpression<?>	id()
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, JoinType joinType)
<X> JpaDerivedJoin<X>	join(Subquery<X> subquery, JoinType joinType, boolean lateral)
<Y> JpaCollectionJoin<T,Y>	join(CollectionAttribute<? super T, Y> collection)
<Y> JpaCollectionJoin<T,Y>	join(CollectionAttribute<? super T, Y> collection, JoinType jt)
<Y> JpaJoin<T,Y>	join(EntityType<Y> entity)
<Y> JpaJoin<T,Y>	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)
<Y> JpaJoin<T,Y>	join(SingularAttribute<? super T, Y> attribute)
<Y> JpaJoin<T,Y>	join(SingularAttribute<? super T, Y> attribute, JoinType jt)
<X> JpaEntityJoin<T,X>	join(Class<X> entityJavaType, JoinType joinType)
<Y> JpaEntityJoin<T,Y>	join(Class<Y> entityClass)
<Y> JpaEntityJoin<T,Y>	join(Class<Y> entityClass, JoinType joinType)
<Y> JpaJoin<T,Y>	join(String attributeName)
<Y> JpaJoin<T,Y>	join(String attributeName, JoinType jt)
<X> JpaEntityJoin<T,X>	join(EntityDomainType<X> entity)
<X> JpaEntityJoin<T,X>	join(EntityDomainType<X> entity, JoinType joinType)
<X> JpaJoin<?,X>	join(JpaCteCriteria<X> cte)
<X> JpaJoin<?,X>	join(JpaCteCriteria<X> cte, JoinType joinType)
<X> JpaFunctionJoin<X>	join(JpaSetReturningFunction<X> function)	Like calling the overload join(JpaSetReturningFunction, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	join(JpaSetReturningFunction<X> function, SqmJoinType joinType)	Like calling the overload 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 joinArray(SingularAttribute, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArray(SingularAttribute<? super T, X[]> arrayAttribute, SqmJoinType joinType)	Like calling the overload join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestArray(Expression) with the given attribute.
<X> JpaFunctionJoin<X>	joinArray(String arrayAttributeName)	Like calling the overload joinArray(String, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArray(String arrayAttributeName, SqmJoinType joinType)	Like calling the overload 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 joinArrayCollection(SingularAttribute, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArrayCollection(SingularAttribute<? super T, ? extends Collection<X>> collectionAttribute, SqmJoinType joinType)	Like calling the overload join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestCollection(Expression) with the given attribute.
<X> JpaFunctionJoin<X>	joinArrayCollection(String collectionAttributeName)	Like calling the overload joinArrayCollection(String, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinArrayCollection(String collectionAttributeName, SqmJoinType joinType)	Like calling the overload join(JpaSetReturningFunction, SqmJoinType) with HibernateCriteriaBuilder.unnestCollection(Expression) with the result of JpaPath.get(String) passing the given attribute name.
<Y> JpaCollectionJoin<T,Y>	joinCollection(String attributeName)
<Y> JpaCollectionJoin<T,Y>	joinCollection(String attributeName, JoinType jt)
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery)
<X> JpaDerivedJoin<X>	joinLateral(Subquery<X> subquery, JoinType joinType)
<X> JpaFunctionJoin<X>	joinLateral(JpaSetReturningFunction<X> function)	Like calling the overload joinLateral(JpaSetReturningFunction, SqmJoinType) with SqmJoinType.INNER.
<X> JpaFunctionJoin<X>	joinLateral(JpaSetReturningFunction<X> function, SqmJoinType joinType)	Like calling the overload join(JpaSetReturningFunction, SqmJoinType, boolean) passing true for the lateral parameter.
<Y> JpaListJoin<T,Y>	joinList(String attributeName)
<Y> JpaListJoin<T,Y>	joinList(String attributeName, JoinType jt)
<K,V> JpaMapJoin<T,K,V>	joinMap(String attributeName)
<K,V> JpaMapJoin<T,K,V>	joinMap(String attributeName, JoinType jt)
<Y> JpaSetJoin<T,Y>	joinSet(String attributeName)
<Y> JpaSetJoin<T,Y>	joinSet(String attributeName, JoinType jt)
default <S extends T> JpaFrom<?,S>	treat(Class<S> treatJavaType)
<S extends T> JpaTreatedFrom<O,T,S>	treatAs(Class<S> treatJavaType)	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 From

getJoinList, getJoins, isCorrelated

Methods inherited from interface JpaExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, coalesce, coalesce, count, countDistinct, equalTo, equalTo, in, in, in, in, in, isMember, isNotMember, isNotNull, isNull, notEqualTo, notEqualTo, nullif, nullif, selectCase, selectCase

Methods inherited from interface JpaFetchParent

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

Methods inherited from interface JpaPath

get, get, get, get, getLhs, getNavigablePath, getParentPath, type

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum

Methods inherited from interface Path

get, get, get, get, get, getModel

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface TupleElement

getAlias

Method Details

getCorrelationParent

@Nonnull
JpaFrom<O,T> getCorrelationParent()

Specified by:

getCorrelationParent in interface From<O,T>

join

@Nonnull
<Y> JpaEntityJoin<T,Y> join(@Nonnull
 Class<Y> entityClass)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaEntityJoin<T,Y> join(@Nonnull
 Class<Y> entityClass,
 @Nonnull
 JoinType joinType)

Specified by:

join in interface From<O,T>

join

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

join

@Nonnull
<Y> JpaJoin<T,Y> join(@Nonnull
 EntityType<Y> entity)

Specified by:

join in interface From<O,T>

join

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

Specified by:

join in interface From<O,T>

join

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

join

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

join

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

join

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

joinLateral

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

joinLateral

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

join

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

join

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

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

Since:

7.0

See Also:

• join(JpaSetReturningFunction, SqmJoinType)

join

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

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

Since:

7.0

See Also:

• join(JpaSetReturningFunction, SqmJoinType, boolean)

joinLateral

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

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

Since:

7.0

See Also:

• joinLateral(JpaSetReturningFunction, SqmJoinType)

joinLateral

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

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

Since:

7.0

See Also:

• join(JpaSetReturningFunction, SqmJoinType, boolean)

join

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

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.

Since:

7.0

joinArray

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

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

Since:

7.0

See Also:

• joinArray(String, SqmJoinType)

joinArray

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

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

Since:

7.0

See Also:

• joinLateral(JpaSetReturningFunction, SqmJoinType)

joinArray

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

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

Since:

7.0

See Also:

• joinArray(SingularAttribute, SqmJoinType)

joinArray

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

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

Since:

7.0

See Also:

• joinLateral(JpaSetReturningFunction, SqmJoinType)

joinArrayCollection

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

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

Since:

7.0

See Also:

• joinArrayCollection(String, SqmJoinType)

joinArrayCollection

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

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

Since:

7.0

See Also:

• joinLateral(JpaSetReturningFunction, SqmJoinType)

joinArrayCollection

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

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

Since:

7.0

See Also:

• joinArrayCollection(SingularAttribute, SqmJoinType)

joinArrayCollection

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

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

Since:

7.0

See Also:

• joinLateral(JpaSetReturningFunction, SqmJoinType)

join

@Incubating
@Nonnull
<X> JpaJoin<?,X> join(@Nonnull
 JpaCteCriteria<X> cte)

join

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

crossJoin

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

crossJoin

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

join

@Nonnull
<Y> JpaJoin<T,Y> join(@Nonnull
 SingularAttribute<? super T, Y> attribute)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaJoin<T,Y> join(@Nonnull
 SingularAttribute<? super T, Y> attribute,
 @Nonnull
 JoinType jt)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaCollectionJoin<T,Y> join(@Nonnull
 CollectionAttribute<? super T, Y> collection)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaSetJoin<T,Y> join(@Nonnull
 SetAttribute<? super T, Y> set)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaListJoin<T,Y> join(@Nonnull
 ListAttribute<? super T, Y> list)

Specified by:

join in interface From<O,T>

join

@Nonnull
<K,V> JpaMapJoin<T,K,V> join(@Nonnull
 MapAttribute<? super T, K, V> map)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaCollectionJoin<T,Y> join(@Nonnull
 CollectionAttribute<? super T, Y> collection,
 @Nonnull
 JoinType jt)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaSetJoin<T,Y> join(@Nonnull
 SetAttribute<? super T, Y> set,
 @Nonnull
 JoinType jt)

Specified by:

join in interface From<O,T>

join

@Nonnull
<Y> JpaListJoin<T,Y> join(@Nonnull
 ListAttribute<? super T, Y> list,
 @Nonnull
 JoinType jt)

Specified by:

join in interface From<O,T>

join

@Nonnull
<K,V> JpaMapJoin<T,K,V> join(@Nonnull
 MapAttribute<? super T, K, V> map,
 @Nonnull
 JoinType jt)

Specified by:

join in interface From<O,T>

join

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

Specified by:

join in interface From<O,T>

joinCollection

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

Specified by:

joinCollection in interface From<O,T>

joinSet

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

Specified by:

joinSet in interface From<O,T>

joinList

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

Specified by:

joinList in interface From<O,T>

joinMap

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

Specified by:

joinMap in interface From<O,T>

join

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

Specified by:

join in interface From<O,T>

joinCollection

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

Specified by:

joinCollection in interface From<O,T>

joinSet

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

Specified by:

joinSet in interface From<O,T>

joinList

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

Specified by:

joinList in interface From<O,T>

joinMap

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

Specified by:

joinMap in interface From<O,T>

treatAs

@Nonnull
<S extends T> JpaTreatedFrom<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 JpaPath<O>

treat

@Nonnull
default <S extends T> JpaFrom<?,S> treat(@Nonnull
 Class<S> treatJavaType)

Specified by:

treat in interface From<O,T>

Specified by:

treat in interface JpaPath<O>

Specified by:

treat in interface Path<O>

treatAs

@Nonnull
<S extends T> JpaTreatedFrom<O,T,S> treatAs(@Nonnull
 EntityDomainType<S> treatJavaType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaPath<O>

id

@Incubating
@Nonnull
JpaExpression<?> id()