- Type Parameters:
Z
- the source typeX
- the target type
- All Superinterfaces:
Expression<X>
,FetchParent<Z,
,X> Path<X>
,Selection<X>
,TupleElement<X>
- All Known Subinterfaces:
CollectionJoin<Z,
,E> Join<Z,
,X> ListJoin<Z,
,E> MapJoin<Z,
,K, V> PluralJoin<Z,
,C, E> Root<X>
,SetJoin<Z,
E>
Represents a bound type, usually an entity that appears in
the from clause, but may also be an embeddable belonging to
an entity in the from clause.
Serves as a factory for Join
s of associations,
embeddables, and collections belonging to the type, and for
Path
s of attributes belonging to the type.
- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptionReturns the parentFrom
object from which the correlatedFrom
object has been obtained through correlation (use ofSubquery.correlate(jakarta.persistence.criteria.Root<Y>)
method).getJoins()
Return the joins that have been made from this bound type.boolean
Whether theFrom
object has been obtained as a result of correlation (use of aSubquery.correlate(jakarta.persistence.criteria.Root<Y>)
method).<Y> CollectionJoin
<X, Y> join
(CollectionAttribute<? super X, Y> collection) Create an inner join to the specifiedCollection
-valued attribute.<Y> CollectionJoin
<X, Y> join
(CollectionAttribute<? super X, Y> collection, JoinType jt) Create a join to the specifiedCollection
-valued attribute using the given join type.join
(EntityType<Y> entity) Create and add an inner join to the given entity.join
(EntityType<Y> entity, JoinType joinType) Create and add a join to the given entity.join
(ListAttribute<? super X, Y> list) Create an inner join to the specifiedList
-valued attribute.join
(ListAttribute<? super X, Y> list, JoinType jt) Create a join to the specifiedList
-valued attribute using the given join type.join
(MapAttribute<? super X, K, V> map) Create an inner join to the specifiedMap
-valued attribute.join
(MapAttribute<? super X, K, V> map, JoinType jt) Create a join to the specifiedMap
-valued attribute using the given join type.join
(SetAttribute<? super X, Y> set) Create an inner join to the specifiedSet
-valued attribute.join
(SetAttribute<? super X, Y> set, JoinType jt) Create a join to the specifiedSet
-valued attribute using the given join type.join
(SingularAttribute<? super X, Y> attribute) Create an inner join to the specified single-valued attribute.join
(SingularAttribute<? super X, Y> attribute, JoinType jt) Create a join to the specified single-valued attribute using the given join type.Create and add an inner join to the given entity.Create and add a join to the given entity.<X,
Y> Join <X, Y> Create an inner join to the specified attribute.<X,
Y> Join <X, Y> Create a join to the specified attribute using the given join type.<X,
Y> CollectionJoin <X, Y> joinCollection
(String attributeName) Create an inner join to the specifiedCollection
-valued attribute.<X,
Y> CollectionJoin <X, Y> joinCollection
(String attributeName, JoinType jt) Create a join to the specifiedCollection
-valued attribute using the given join type.<X,
Y> ListJoin <X, Y> Create an inner join to the specifiedList
-valued attribute.<X,
Y> ListJoin <X, Y> Create a join to the specifiedList
-valued attribute using the given join type.<X,
K, V> MapJoin <X, K, V> Create an inner join to the specifiedMap
-valued attribute.<X,
K, V> MapJoin <X, K, V> Create a join to the specifiedMap
-valued attribute using the given join type.<X,
Y> SetJoin <X, Y> Create an inner join to the specifiedSet
-valued attribute.<X,
Y> SetJoin <X, Y> Create a join to the specifiedSet
-valued attribute using the given join type.Methods inherited from interface jakarta.persistence.criteria.Expression
as, cast, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo
Methods inherited from interface jakarta.persistence.criteria.FetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches
Methods inherited from interface jakarta.persistence.criteria.Path
get, get, get, get, getModel, getParentPath, type
Methods inherited from interface jakarta.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection
Methods inherited from interface jakarta.persistence.TupleElement
getAlias, getJavaType
-
Method Details
-
getJoins
-
getCorrelationParent
Returns the parentFrom
object from which the correlatedFrom
object has been obtained through correlation (use ofSubquery.correlate(jakarta.persistence.criteria.Root<Y>)
method).- Returns:
- the parent of the correlated
From
object - Throws:
IllegalStateException
- if theFrom
object has not been obtained through correlation
-
join
-
join
-
join
Create and add an inner join to the given entity.- Parameters:
entity
- metamodel entity representing the join target- Returns:
- the resulting join
- Since:
- 3.2
-
join
Create and add a join to the given entity.- Parameters:
entity
- metamodel entity representing the join targetjoinType
- join type- Returns:
- the resulting join
- Since:
- 3.2
-
join
Create an inner join to the specified single-valued attribute.- Parameters:
attribute
- target of the join- Returns:
- the resulting join
-
join
Create a join to the specified single-valued attribute using the given join type.- Parameters:
attribute
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
Create an inner join to the specifiedCollection
-valued attribute.- Parameters:
collection
- target of the join- Returns:
- the resulting join
-
join
Create an inner join to the specifiedSet
-valued attribute.- Parameters:
set
- target of the join- Returns:
- the resulting join
-
join
Create an inner join to the specifiedList
-valued attribute.- Parameters:
list
- target of the join- Returns:
- the resulting join
-
join
Create an inner join to the specifiedMap
-valued attribute.- Parameters:
map
- target of the join- Returns:
- the resulting join
-
join
Create a join to the specifiedCollection
-valued attribute using the given join type.- Parameters:
collection
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
-
join
-
join
-
join
Create an inner join to the specified attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinCollection
Create an inner join to the specifiedCollection
-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinSet
Create an inner join to the specifiedSet
-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinList
Create an inner join to the specifiedList
-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinMap
Create an inner join to the specifiedMap
-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
join
Create a join to the specified attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinCollection
Create a join to the specifiedCollection
-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinSet
Create a join to the specifiedSet
-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinList
Create a join to the specifiedList
-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinMap
Create a join to the specifiedMap
-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-