Jakarta Persistence (JPA) Interface

jakarta.persistence.criteria.Subquery<T>

Type Parameters:
<T> - the type of the selection item.
Super Interfaces:
AbstractQuery<T>, Expression<T>, CommonAbstractCriteria, Selection<T>, TupleElement<X>
The Subquery interface defines functionality that is specific to subqueries.

A subquery has an expression as its selection item.

Since:
Jakarta Persistence (JPA) 2.0

Public Instance Methods

Selection<X> alias(String name)
Assigns an alias to the selection item.
Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.
Inherited from Selection<X>
Parameters:
name - alias
Returns:
selection item.
Since:
Jakarta Persistence (JPA) 1.0
Expression<X> as(Class<X> type)
Perform a typecast upon the expression, returning a new expression object.
Unlike Expression.cast, this method does not cause type conversion: the runtime type is not changed.

Warning: may result in a runtime failure.

Inherited from Expression<T>
Parameters:
type - intended type of the expression
Returns:
new expression of the given type.
See Also:
Since:
Jakarta Persistence (JPA) 1.0
Expression<X> cast(Class<X> type)
Cast this expression to the specified type, returning a new expression object.
Unlike Expression.as, this method does result in a runtime type conversion.

Providers are required to support casting scalar expressions to String, and String expressions to Integer, Long, Float, and Double. Support for typecasts between other basic types is not required.

Inherited from Expression<T>
Parameters:
type - a basic type
Returns:
a scalar expression of the given basic type.
Since:
Jakarta Persistence (JPA) 3.2
Root<Y> correlate(Root<Y> parentRoot)
Create a subquery root correlated to a root of the enclosing query.
Parameters:
parentRoot - a root of the containing query
Returns:
subquery root.
Since:
Jakarta Persistence (JPA) 1.0
Join<X,Y> correlate(Join<X,Y> parentJoin)
Create a subquery join object correlated to a join object of the enclosing query.
Parameters:
parentJoin - join object of the containing query
Returns:
subquery join.
Since:
Jakarta Persistence (JPA) 1.0
CollectionJoin<X,Y> correlate(CollectionJoin<X,Y> parentCollection)
Create a subquery collection join object correlated to a collection join object of the enclosing query.
Parameters:
parentCollection - join object of the containing query
Returns:
subquery join.
Since:
Jakarta Persistence (JPA) 1.0
SetJoin<X,Y> correlate(SetJoin<X,Y> parentSet)
Create a subquery set join object correlated to a set join object of the enclosing query.
Parameters:
parentSet - join object of the containing query
Returns:
subquery join.
Since:
Jakarta Persistence (JPA) 1.0
ListJoin<X,Y> correlate(ListJoin<X,Y> parentList)
Create a subquery list join object correlated to a list join object of the enclosing query.
Parameters:
parentList - join object of the containing query
Returns:
subquery join.
Since:
Jakarta Persistence (JPA) 1.0
MapJoin<X,K,V> correlate(MapJoin<X,K,V> parentMap)
Create a subquery map join object correlated to a map join object of the enclosing query.
Parameters:
parentMap - join object of the containing query
Returns:
subquery join.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> distinct(boolean distinct)
Specify whether duplicate query results are eliminated.
A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
distinct - boolean value specifying whether duplicate results must be eliminated from the subquery result or whether they must be retained
Returns:
the modified subquery..
Since:
Jakarta Persistence (JPA) 1.0
Predicate equalTo(Expression<?> value)
Create a predicate to test whether the expression is equal to the argument.
Inherited from Expression<T>
Parameters:
value - expression to be tested against
Returns:
predicate testing for equality.
Since:
Jakarta Persistence (JPA) 3.2
Predicate equalTo(Object value)
Create a predicate to test whether the expression is equal to the argument.
Inherited from Expression<T>
Parameters:
value - value to be tested against
Returns:
predicate testing for equality.
Since:
Jakarta Persistence (JPA) 3.2
Root<X> from(Class<X> entityClass)
Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
Inherited from AbstractQuery<T>
Parameters:
entityClass - the entity class
Returns:
query root corresponding to the given entity.
Since:
Jakarta Persistence (JPA) 1.0
Root<X> from(EntityType<X> entity)
Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.
Inherited from AbstractQuery<T>
Parameters:
entity - metamodel entity representing the entity of type X
Returns:
query root corresponding to the given entity.
Since:
Jakarta Persistence (JPA) 1.0
String getAlias()
Return the alias assigned to the tuple element or null, if no alias has been assigned.
Inherited from TupleElement<X>
Returns:
alias.
Since:
Jakarta Persistence (JPA) 1.0
List<Selection<?>> getCompoundSelectionItems()
Return the selection items composing a compound selection.
Modifications to the list do not affect the query.
Inherited from Selection<X>
Returns:
list of selection items.
Throws:
IllegalStateException - if selection is not a compound selection.
Since:
Jakarta Persistence (JPA) 1.0
CommonAbstractCriteria getContainingQuery()
Return the query of which this is a subquery.
This may be a CriteriaQuery, CriteriaUpdate, CriteriaDelete, or a Subquery.
Returns:
the enclosing query or subquery.
Since:
Jakarta Persistence (JPA) 2.1
Set<Join<?,?>> getCorrelatedJoins()
Return the correlated joins of the subquery.
Returns empty set if the subquery has no correlated joins. Modifications to the set do not affect the query.
Returns:
the correlated joins of the subquery.
Since:
Jakarta Persistence (JPA) 1.0
List<Expression<?>> getGroupList()
Return a list of the grouping expressions.
Returns empty list if no grouping expressions have been specified. Modifications to the list do not affect the query.
Inherited from AbstractQuery<T>
Returns:
the list of grouping expressions.
Since:
Jakarta Persistence (JPA) 1.0
Predicate getGroupRestriction()
Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified.
Inherited from AbstractQuery<T>
Returns:
having clause predicate.
Since:
Jakarta Persistence (JPA) 1.0
Class<? extends X> getJavaType()
Return the Java type of the tuple element.
Inherited from TupleElement<X>
Returns:
the Java type of the tuple element.
Since:
Jakarta Persistence (JPA) 1.0
Set<ParameterExpression<?>> getParameters()
Return the parameters of the query.
Returns empty set if there are no parameters. Modifications to the set do not affect the query.
Inherited from CommonAbstractCriteria
Returns:
the query parameters.
Since:
Jakarta Persistence (JPA) 1.0
AbstractQuery<?> getParent()
Return the query of which this is a subquery.
This must be a CriteriaQuery or a Subquery.
Returns:
the enclosing query or subquery.
Since:
Jakarta Persistence (JPA) 1.0
Predicate getRestriction()
Return the predicate that corresponds to the where clause restriction(s), or null if no restrictions have been specified.
Inherited from CommonAbstractCriteria
Returns:
where clause predicate.
Since:
Jakarta Persistence (JPA) 1.0
Class<T> getResultType()
Return the result type of the query or subquery.
If a result type was specified as an argument to the createQuery or subquery method, that type is returned. If the query was created using the createTupleQuery method, the result type is Tuple. Otherwise, the result type is Object.
Inherited from AbstractQuery<T>
Returns:
result type.
Since:
Jakarta Persistence (JPA) 1.0
Set<Root<?>> getRoots()
Return the query roots.
These are the roots that are defined for the CriteriaQuery<T> or Subquery<T> itself, including any subquery roots defined as a result of correlation. Returns an empty set if no roots have been defined. Modifications to the set do not affect the query.
Inherited from AbstractQuery<T>
Returns:
the set of query roots.
Since:
Jakarta Persistence (JPA) 1.0
Expression<T> getSelection()
Return the selection expression.
Returns:
the item to be returned in the subquery result.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> groupBy(Expression<?>... grouping)
Specify the expressions that are used to form groups over the subquery results.
Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
grouping - zero or more grouping expressions
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> groupBy(List<Expression<?>> grouping)
Specify the expressions that are used to form groups over the subquery results.
Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
grouping - list of zero or more grouping expressions
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> having(Expression<Boolean> restriction)
Specify a restriction over the groups of the subquery.
Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
restriction - a simple or compound boolean expression
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> having(Predicate... restrictions)
Specify restrictions over the groups of the subquery according the conjunction of the specified restriction predicates.
Replaces the previously added having restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
restrictions - zero or more restriction predicates
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> having(List<Predicate> restrictions)
Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
Replaces the previously added having restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
restrictions - a list of zero or more restriction predicates
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 3.2
Predicate in(Object... values)
Create a predicate to test whether the expression is a member of the argument list.
Inherited from Expression<T>
Parameters:
values - values to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Expression<?>... values)
Create a predicate to test whether the expression is a member of the argument list.
Inherited from Expression<T>
Parameters:
values - expressions to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Collection<?> values)
Create a predicate to test whether the expression is a member of the collection.
Inherited from Expression<T>
Parameters:
values - collection of values to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Expression<Collection<?>> values)
Create a predicate to test whether the expression is a member of the collection.
Inherited from Expression<T>
Parameters:
values - expression corresponding to collection to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
boolean isCompoundSelection()
Whether the selection item is a compound selection.
Inherited from Selection<X>
Returns:
boolean indicating whether the selection is a compound selection.
Since:
Jakarta Persistence (JPA) 1.0
boolean isDistinct()
Return whether duplicate query results must be eliminated or retained.
Inherited from AbstractQuery<T>
Returns:
boolean indicating whether duplicate query results must be eliminated.
Since:
Jakarta Persistence (JPA) 1.0
Predicate isNotNull()
Create a predicate to test whether the expression is not null.
Inherited from Expression<T>
Returns:
predicate testing whether the expression is not null.
Since:
Jakarta Persistence (JPA) 1.0
Predicate isNull()
Create a predicate to test whether the expression is null.
Inherited from Expression<T>
Returns:
predicate testing whether the expression is null.
Since:
Jakarta Persistence (JPA) 1.0
Predicate notEqualTo(Expression<?> value)
Create a predicate to test whether the expression is unequal to the argument.
Inherited from Expression<T>
Parameters:
value - expression to be tested against
Returns:
predicate testing for inequality.
Since:
Jakarta Persistence (JPA) 3.2
Predicate notEqualTo(Object value)
Create a predicate to test whether the expression is unequal to the argument.
Inherited from Expression<T>
Parameters:
value - value to be tested against
Returns:
predicate testing for inequality.
Since:
Jakarta Persistence (JPA) 3.2
Subquery<T> select(Expression<T> expression)
Specify the item that is to be returned as the subquery result.
Replaces the previously specified selection, if any.
Parameters:
expression - expression specifying the item that is to be returned as the subquery result
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<U> subquery(Class<U> type)
Create a subquery of the query.
Inherited from CommonAbstractCriteria
Parameters:
type - the subquery result type
Returns:
subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<U> subquery(EntityType<U> type)
Create a subquery of the query.
Inherited from CommonAbstractCriteria
Parameters:
type - the subquery result type
Returns:
subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> where(Expression<Boolean> restriction)
Modify the subquery to restrict the result according to the specified boolean expression.
Replaces the previously added restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
restriction - a simple or compound boolean expression
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> where(Predicate... restrictions)
Modify the subquery to restrict the result according to the conjunction of the specified restriction predicates.
Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
restrictions - zero or more restriction predicates
Returns:
the modified subquery.
Since:
Jakarta Persistence (JPA) 1.0
Subquery<T> where(List<Predicate> restrictions)
Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.
Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.
Parameters:
restrictions - a list of zero or more restriction predicates
Returns:
the modified query.
Since:
Jakarta Persistence (JPA) 3.2