Top Description Methods
org.hibernate.query.criteria

public Interface JpaFrom<O, T>

extends JpaPath<T>, JpaFetchParent<O, T>, From<O, T>
Known Direct Subinterfaces
org.hibernate.query.criteria.JpaJoinedFrom, org.hibernate.query.criteria.JpaRoot, org.hibernate.query.sqm.tree.from.SqmFrom, org.hibernate.query.criteria.JpaCrossJoin, org.hibernate.query.criteria.JpaDerivedFrom
Imports
org.hibernate.Incubating, org.hibernate.metamodel.model.domain.EntityDomainType, org.hibernate.query.sqm.tree.SqmJoinType, jakarta.persistence.criteria.From, .JoinType, .Subquery, jakarta.persistence.metamodel.CollectionAttribute, .ListAttribute, .MapAttribute, .SetAttribute, .SingularAttribute
API extension to the JPA From contract
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public <X> JpaCrossJoin<X>
crossJoin(Class<X> entityJavaType)

public <X> JpaCrossJoin<X>
crossJoin(EntityDomainType<X> entity)

public JpaFrom<O, T>
getCorrelationParent()

Redeclares jakarta.persistence.criteria.From.getCorrelationParent.

Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).
public <X> JpaEntityJoin<X>
join(Class<X> entityJavaType)

public <X> JpaEntityJoin<X>
join(EntityDomainType<X> entity)

public <X> JpaEntityJoin<X>
join(Class<X> entityJavaType, SqmJoinType joinType)

public <X> JpaEntityJoin<X>
join(EntityDomainType<X> entity, SqmJoinType joinType)

public <X> JpaDerivedJoin<X>
join(Subquery<X> subquery)

public <X> JpaDerivedJoin<X>
join(Subquery<X> subquery, SqmJoinType joinType)

public <X> JpaDerivedJoin<X>
join(Subquery<X> subquery, SqmJoinType joinType, boolean lateral)

public <X> JpaJoinedFrom<?, X>
join(JpaCteCriteria<X> cte)

public <X> JpaJoinedFrom<?, X>
join(JpaCteCriteria<X> cte, SqmJoinType joinType)

public <Y> JpaJoin<T, Y>
join(SingularAttribute<? super T, Y>
target of the join
attribute)

Redeclares jakarta.persistence.criteria.From.join.

Create an inner join to the specified single-valued attribute.
public <Y> JpaJoin<T, Y>
join(SingularAttribute<? super T, Y>
target of the join
attribute, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.join.

Create a join to the specified single-valued attribute using the given join type.
public <Y> JpaCollectionJoin<T, Y>
join(CollectionAttribute<? super T, Y>
target of the join
collection)

Redeclares jakarta.persistence.criteria.From.join.

Create an inner join to the specified Collection-valued attribute.
public <Y> JpaSetJoin<T, Y>
join(SetAttribute<? super T, Y>
target of the join
set)

Redeclares jakarta.persistence.criteria.From.join.

Create an inner join to the specified Set-valued attribute.
public <Y> JpaListJoin<T, Y>
join(ListAttribute<? super T, Y>
target of the join
list)

Redeclares jakarta.persistence.criteria.From.join.

Create an inner join to the specified List-valued attribute.
public <K, V> JpaMapJoin<T, K, V>
join(MapAttribute<? super T, K, V>
target of the join
map)

Redeclares jakarta.persistence.criteria.From.join.

Create an inner join to the specified Map-valued attribute.
public <Y> JpaCollectionJoin<T, Y>
join(CollectionAttribute<? super T, Y>
target of the join
collection, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.join.

Create a join to the specified Collection-valued attribute using the given join type.
public <Y> JpaSetJoin<T, Y>
join(SetAttribute<? super T, Y>
target of the join
set, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.join.

Create a join to the specified Set-valued attribute using the given join type.
public <Y> JpaListJoin<T, Y>
join(ListAttribute<? super T, Y>
target of the join
list, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.join.

Create a join to the specified List-valued attribute using the given join type.
public <K, V> JpaMapJoin<T, K, V>
join(MapAttribute<? super T, K, V>
target of the join
map, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.join.

Create a join to the specified Map-valued attribute using the given join type.
public <X, Y> JpaJoin<X, Y>
join(String
name of the attribute for the target of the join
attributeName)

Redeclares jakarta.persistence.criteria.From.join.

Create an inner join to the specified attribute.
public <X, Y> JpaJoin<X, Y>
join(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.join.

Create a join to the specified attribute using the given join type.
public <X, Y> JpaCollectionJoin<X, Y>
joinCollection(String
name of the attribute for the target of the join
attributeName)

Redeclares jakarta.persistence.criteria.From.joinCollection.

Create an inner join to the specified Collection-valued attribute.
public <X, Y> JpaCollectionJoin<X, Y>
joinCollection(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.joinCollection.

Create a join to the specified Collection-valued attribute using the given join type.
public <X> JpaDerivedJoin<X>
joinLateral(Subquery<X> subquery)

public <X> JpaDerivedJoin<X>
joinLateral(Subquery<X> subquery, SqmJoinType joinType)

public <X, Y> JpaListJoin<X, Y>
joinList(String
name of the attribute for the target of the join
attributeName)

Redeclares jakarta.persistence.criteria.From.joinList.

Create an inner join to the specified List-valued attribute.
public <X, Y> JpaListJoin<X, Y>
joinList(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.joinList.

Create a join to the specified List-valued attribute using the given join type.
public <X, K, V> JpaMapJoin<X, K, V>
joinMap(String
name of the attribute for the target of the join
attributeName)

Redeclares jakarta.persistence.criteria.From.joinMap.

Create an inner join to the specified Map-valued attribute.
public <X, K, V> JpaMapJoin<X, K, V>
joinMap(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.joinMap.

Create a join to the specified Map-valued attribute using the given join type.
public <X, Y> JpaSetJoin<X, Y>
joinSet(String
name of the attribute for the target of the join
attributeName)

Redeclares jakarta.persistence.criteria.From.joinSet.

Create an inner join to the specified Set-valued attribute.
public <X, Y> JpaSetJoin<X, Y>
joinSet(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Redeclares jakarta.persistence.criteria.From.joinSet.

Create a join to the specified Set-valued attribute using the given join type.
Inherited from jakarta.persistence.criteria.From:
getJoinsisCorrelated
Inherited from org.hibernate.query.criteria.JpaFetchParent:
fetchfetchfetchfetchfetchfetchgetFetches
Inherited from org.hibernate.query.criteria.JpaPath:
getgetgetgetgetLhsgetNavigablePathgetParentPathtreatAstreatAstype

Method Detail

crossJoinback to summary
public <X> JpaCrossJoin<X> crossJoin(Class<X> entityJavaType)
Annotations
@Incubating
crossJoinback to summary
public <X> JpaCrossJoin<X> crossJoin(EntityDomainType<X> entity)
Annotations
@Incubating
getCorrelationParentback to summary
public JpaFrom<O, T> getCorrelationParent()

Redeclares jakarta.persistence.criteria.From.getCorrelationParent.

Doc from jakarta.persistence.criteria.From.getCorrelationParent.

Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).

Returns:JpaFrom<O, T>

the parent of the correlated From object

Annotations
@Override
joinback to summary
public <X> JpaEntityJoin<X> join(Class<X> entityJavaType)
joinback to summary
public <X> JpaEntityJoin<X> join(EntityDomainType<X> entity)
joinback to summary
public <X> JpaEntityJoin<X> join(Class<X> entityJavaType, SqmJoinType joinType)
joinback to summary
public <X> JpaEntityJoin<X> join(EntityDomainType<X> entity, SqmJoinType joinType)
joinback to summary
public <X> JpaDerivedJoin<X> join(Subquery<X> subquery)
Annotations
@Incubating
joinback to summary
public <X> JpaDerivedJoin<X> join(Subquery<X> subquery, SqmJoinType joinType)
Annotations
@Incubating
joinback to summary
public <X> JpaDerivedJoin<X> join(Subquery<X> subquery, SqmJoinType joinType, boolean lateral)
Annotations
@Incubating
joinback to summary
public <X> JpaJoinedFrom<?, X> join(JpaCteCriteria<X> cte)
Annotations
@Incubating
joinback to summary
public <X> JpaJoinedFrom<?, X> join(JpaCteCriteria<X> cte, SqmJoinType joinType)
Annotations
@Incubating
joinback to summary
public <Y> JpaJoin<T, Y> join(SingularAttribute<? super T, Y> attribute)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified single-valued attribute.

Parameters
attribute:SingularAttribute<? super T, Y>

target of the join

Returns:JpaJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaJoin<T, Y> join(SingularAttribute<? super T, Y> attribute, JoinType jt)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified single-valued attribute using the given join type.

Parameters
attribute:SingularAttribute<? super T, Y>

target of the join

jt:JoinType

join type

Returns:JpaJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaCollectionJoin<T, Y> join(CollectionAttribute<? super T, Y> collection)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified Collection-valued attribute.

Parameters
collection:CollectionAttribute<? super T, Y>

target of the join

Returns:JpaCollectionJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaSetJoin<T, Y> join(SetAttribute<? super T, Y> set)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified Set-valued attribute.

Parameters
set:SetAttribute<? super T, Y>

target of the join

Returns:JpaSetJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaListJoin<T, Y> join(ListAttribute<? super T, Y> list)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified List-valued attribute.

Parameters
list:ListAttribute<? super T, Y>

target of the join

Returns:JpaListJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <K, V> JpaMapJoin<T, K, V> join(MapAttribute<? super T, K, V> map)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified Map-valued attribute.

Parameters
map:MapAttribute<? super T, K, V>

target of the join

Returns:JpaMapJoin<T, K, V>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaCollectionJoin<T, Y> join(CollectionAttribute<? super T, Y> collection, JoinType jt)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified Collection-valued attribute using the given join type.

Parameters
collection:CollectionAttribute<? super T, Y>

target of the join

jt:JoinType

join type

Returns:JpaCollectionJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaSetJoin<T, Y> join(SetAttribute<? super T, Y> set, JoinType jt)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified Set-valued attribute using the given join type.

Parameters
set:SetAttribute<? super T, Y>

target of the join

jt:JoinType

join type

Returns:JpaSetJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> JpaListJoin<T, Y> join(ListAttribute<? super T, Y> list, JoinType jt)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified List-valued attribute using the given join type.

Parameters
list:ListAttribute<? super T, Y>

target of the join

jt:JoinType

join type

Returns:JpaListJoin<T, Y>

the resulting join

Annotations
@Override
joinback to summary
public <K, V> JpaMapJoin<T, K, V> join(MapAttribute<? super T, K, V> map, JoinType jt)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified Map-valued attribute using the given join type.

Parameters
map:MapAttribute<? super T, K, V>

target of the join

jt:JoinType

join type

Returns:JpaMapJoin<T, K, V>

the resulting join

Annotations
@Override
joinback to summary
public <X, Y> JpaJoin<X, Y> join(String attributeName)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified attribute.

Parameters
attributeName:String

name of the attribute for the target of the join

Returns:JpaJoin<X, Y>

the resulting join

Annotations
@Override
joinback to summary
public <X, Y> JpaJoin<X, Y> join(String attributeName, JoinType jt)

Redeclares jakarta.persistence.criteria.From.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:JpaJoin<X, Y>

the resulting join

Annotations
@Override
joinCollectionback to summary
public <X, Y> JpaCollectionJoin<X, Y> joinCollection(String attributeName)

Redeclares jakarta.persistence.criteria.From.joinCollection.

Doc from jakarta.persistence.criteria.From.joinCollection.

Create an inner join to the specified Collection-valued attribute.

Parameters
attributeName:String

name of the attribute for the target of the join

Returns:JpaCollectionJoin<X, Y>

the resulting join

Annotations
@Override
joinCollectionback to summary
public <X, Y> JpaCollectionJoin<X, Y> joinCollection(String attributeName, JoinType jt)

Redeclares jakarta.persistence.criteria.From.joinCollection.

Doc from jakarta.persistence.criteria.From.joinCollection.

Create a join to the specified Collection-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:JpaCollectionJoin<X, Y>

the resulting join

Annotations
@Override
joinLateralback to summary
public <X> JpaDerivedJoin<X> joinLateral(Subquery<X> subquery)
Annotations
@Incubating
joinLateralback to summary
public <X> JpaDerivedJoin<X> joinLateral(Subquery<X> subquery, SqmJoinType joinType)
Annotations
@Incubating
joinListback to summary
public <X, Y> JpaListJoin<X, Y> joinList(String attributeName)

Redeclares jakarta.persistence.criteria.From.joinList.

Doc from jakarta.persistence.criteria.From.joinList.

Create an inner join to the specified List-valued attribute.

Parameters
attributeName:String

name of the attribute for the target of the join

Returns:JpaListJoin<X, Y>

the resulting join

Annotations
@Override
joinListback to summary
public <X, Y> JpaListJoin<X, Y> joinList(String attributeName, JoinType jt)

Redeclares jakarta.persistence.criteria.From.joinList.

Doc from jakarta.persistence.criteria.From.joinList.

Create a join to the specified List-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:JpaListJoin<X, Y>

the resulting join

Annotations
@Override
joinMapback to summary
public <X, K, V> JpaMapJoin<X, K, V> joinMap(String attributeName)

Redeclares jakarta.persistence.criteria.From.joinMap.

Doc from jakarta.persistence.criteria.From.joinMap.

Create an inner join to the specified Map-valued attribute.

Parameters
attributeName:String

name of the attribute for the target of the join

Returns:JpaMapJoin<X, K, V>

the resulting join

Annotations
@Override
joinMapback to summary
public <X, K, V> JpaMapJoin<X, K, V> joinMap(String attributeName, JoinType jt)

Redeclares jakarta.persistence.criteria.From.joinMap.

Doc from jakarta.persistence.criteria.From.joinMap.

Create a join to the specified Map-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:JpaMapJoin<X, K, V>

the resulting join

Annotations
@Override
joinSetback to summary
public <X, Y> JpaSetJoin<X, Y> joinSet(String attributeName)

Redeclares jakarta.persistence.criteria.From.joinSet.

Doc from jakarta.persistence.criteria.From.joinSet.

Create an inner join to the specified Set-valued attribute.

Parameters
attributeName:String

name of the attribute for the target of the join

Returns:JpaSetJoin<X, Y>

the resulting join

Annotations
@Override
joinSetback to summary
public <X, Y> JpaSetJoin<X, Y> joinSet(String attributeName, JoinType jt)

Redeclares jakarta.persistence.criteria.From.joinSet.

Doc from jakarta.persistence.criteria.From.joinSet.

Create a join to the specified Set-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:JpaSetJoin<X, Y>

the resulting join

Annotations
@Override