Module org.eclipse.persistence.jpa
Class CriteriaQueryImpl<T>
java.lang.Object
org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl<T>
org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl<T>
org.eclipse.persistence.internal.jpa.querydef.CriteriaQueryImpl<T>
- All Implemented Interfaces:
AbstractQuery<T>
,CommonAbstractCriteria
,CriteriaQuery<T>
,Serializable
Purpose: Contains the implementation of the CriteriaQuery interface of the JPA criteria API.
Description: This is the container class for the components that define a query.
- Since:
- EclipseLink 1.2
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl
AbstractQueryImpl.ResultType
-
Field Summary
Fields inherited from class org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl
baseExpression, distinct, groupBy, havingClause, queryResult, roots
Fields inherited from class org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl
metamodel, parameters, queryBuilder, queryType, where
-
Constructor Summary
ConstructorDescriptionCriteriaQueryImpl
(Metamodel metamodel, AbstractQueryImpl.ResultType queryResult, Class<T> result, CriteriaBuilderImpl queryBuilder) -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected ObjectLevelReadQuery
Translates from the criteria query to a EclipseLink Database Query.protected ObjectLevelReadQuery
distinct
(boolean distinct) Specify whether duplicate query results will be eliminated.protected DatabaseQuery
Return the ordering expressions in order of precedence.Return the selection item of the query.groupBy
(Expression<?>... grouping) Specify the expressions that are used to form groups over the query results.groupBy
(List<Expression<?>> grouping) Specify the expressions that are used to form groups over the query results.having
(Expression<Boolean> restriction) Specify a restriction over the groups of the query.Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.multiselect
(Selection<?>... selections) Specify the items that are to be returned in the query result.multiselect
(List<Selection<?>> selectionList) Specify the items that are to be returned in the query result.Specify the ordering expressions that are used to order the query results.Specify the ordering expressions that are used to order the query results.void
populateAndSetConstructorSelection
(ConstructorSelectionImpl constructorSelection, Class<?> class1, Selection<?>... selections) This method will set this queryImpl's selection to a ConstructorSelectionImpl, creating a new instance or populating the one passed in as necessary.Specify the item that is to be returned in the query result.Translates from the criteria query to a EclipseLink Database Query.where
(Expression<Boolean> restriction) Modify the query to restrict the query result according to the specified boolean expression.Modify the query to restrict the query result according to the conjunction of the specified restriction predicates.Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl
findJoins, from, from, getBaseExpression, getBaseExpression, getGroupList, getGroupRestriction, getRoots, integrateRoot, isDistinct
Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl
addParameter, findRootAndParameters, findRootAndParameters, getParameters, getRestriction, getResultType, internalFrom, internalFrom, subquery
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.persistence.criteria.AbstractQuery
from, from, getGroupList, getGroupRestriction, getResultType, getRoots, isDistinct
Methods inherited from interface jakarta.persistence.criteria.CommonAbstractCriteria
getRestriction, subquery
Methods inherited from interface jakarta.persistence.criteria.CriteriaQuery
getParameters
-
Field Details
-
selection
-
orderBy
-
joins
-
-
Constructor Details
-
CriteriaQueryImpl
public CriteriaQueryImpl(Metamodel metamodel, AbstractQueryImpl.ResultType queryResult, Class<T> result, CriteriaBuilderImpl queryBuilder)
-
-
Method Details
-
select
Specify the item that is to be returned in the query result. Replaces the previously specified selection, if any.- Specified by:
select
in interfaceCriteriaQuery<T>
- Parameters:
selection
- selection specifying the item that is to be returned in the query result- Returns:
- the modified query
-
multiselect
Specify the items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the criteria query object as well as the arguments to the multiselect method as follows: If the type of the criteria query is CriteriaQuery<Tuple>, a Tuple object corresponding to the arguments of the multiselect method will be instantiated and returned for each row that results from the query execution. If the type of the criteria query is CriteriaQuery<X> for some user-defined class X, then the arguments to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row. The IllegalStateException will be thrown if a constructor for the given argument types does not exist. If the type of the criteria query is CriteriaQuery<X[]> for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the arguments of the multiselect method. The IllegalStateException will be thrown if the arguments to the multiselect method are not of type X. If the type of the criteria query is CriteriaQuery<Object>, and only a single argument is passed to the multiselect method, an instance of type Object will be returned for each row. If the type of the criteria query is CriteriaQuery<Object>, and more than one argument is passed to the multiselect method, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the arguments to the multiselect method.- Specified by:
multiselect
in interfaceCriteriaQuery<T>
- Parameters:
selections
- expressions specifying the items that are to be returned in the query result- Returns:
- the modified query
-
multiselect
Specify the items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the criteria query object as well as the arguments to the multiselect method as follows: If the type of the criteria query is CriteriaQuery<Tuple>, a Tuple object corresponding to the items in the selection list passed to the multiselect method will be instantiated and returned for each row that results from the query execution. If the type of the criteria query is CriteriaQuery<X> for some user-defined class X, then the items in the selection list passed to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row. The IllegalStateException will be thrown if a constructor for the given argument types does not exist. If the type of the criteria query is CriteriaQuery<X[]> for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the items in the selection list passed to the multiselect method. The IllegalStateException will be thrown if the elements in the selection list passed to the multiselect method are not of type X. If the type of the criteria query is CriteriaQuery<Object>, and the selection list passed to the multiselect method contains only a single item, an instance of type Object will be returned for each row. If the type of the criteria query is CriteriaQuery<Object>, and the selection list passed to the multiselect method contains more than one item, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the items in the selection list passed to the multiselect method.- Specified by:
multiselect
in interfaceCriteriaQuery<T>
- Parameters:
selectionList
- list of expressions specifying the items that to be are returned in the query result- Returns:
- the modified query
-
where
Modify the query to restrict the query 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.- Specified by:
where
in interfaceAbstractQuery<T>
- Specified by:
where
in interfaceCriteriaQuery<T>
- Overrides:
where
in classAbstractQueryImpl<T>
- Parameters:
restriction
- a simple or compound boolean expression- Returns:
- the modified query
-
where
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.- Specified by:
where
in interfaceAbstractQuery<T>
- Specified by:
where
in interfaceCriteriaQuery<T>
- Overrides:
where
in classAbstractQueryImpl<T>
- Parameters:
restrictions
- zero or more restriction predicates- Returns:
- the modified query
-
groupBy
Specify the expressions that are used to form groups over the query 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.- Specified by:
groupBy
in interfaceAbstractQuery<T>
- Specified by:
groupBy
in interfaceCriteriaQuery<T>
- Overrides:
groupBy
in classAbstractQueryImpl<T>
- Parameters:
grouping
- zero or more grouping expressions- Returns:
- the modified query
-
groupBy
Specify the expressions that are used to form groups over the query 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.- Specified by:
groupBy
in interfaceAbstractQuery<T>
- Specified by:
groupBy
in interfaceCriteriaQuery<T>
- Overrides:
groupBy
in classAbstractQueryImpl<T>
- Parameters:
grouping
- list of zero or more grouping expressions- Returns:
- the modified query
-
having
Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.- Specified by:
having
in interfaceAbstractQuery<T>
- Specified by:
having
in interfaceCriteriaQuery<T>
- Overrides:
having
in classAbstractQueryImpl<T>
- Parameters:
restriction
- a simple or compound boolean expression- Returns:
- the modified query
-
having
Specify restrictions over the groups of the query according 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.- Specified by:
having
in interfaceAbstractQuery<T>
- Specified by:
having
in interfaceCriteriaQuery<T>
- Overrides:
having
in classAbstractQueryImpl<T>
- Parameters:
restrictions
- zero or more restriction predicates- Returns:
- the modified query
-
orderBy
Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The left-to-right sequence of the ordering expressions determines the precedence, whereby the leftmost has highest precedence.- Specified by:
orderBy
in interfaceCriteriaQuery<T>
- Parameters:
o
- zero or more ordering expressions- Returns:
- the modified query.
-
orderBy
Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The order of the ordering expressions in the list determines the precedence, whereby the first element in the list has highest precedence.- Specified by:
orderBy
in interfaceCriteriaQuery<T>
- Parameters:
o
- list of zero or more ordering expressions- Returns:
- the modified query.
-
populateAndSetConstructorSelection
public void populateAndSetConstructorSelection(ConstructorSelectionImpl constructorSelection, Class<?> class1, Selection<?>... selections) throws IllegalArgumentException This method will set this queryImpl's selection to a ConstructorSelectionImpl, creating a new instance or populating the one passed in as necessary. Throws IllegalArgumentException if a constructor taking arguments represented by the selections array doesn't exist for the given class. Also sets the query result to ResultType.CONSTRUCTOR- Throws:
IllegalArgumentException
-
distinct
Specify whether duplicate query results will be 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.- Specified by:
distinct
in interfaceAbstractQuery<T>
- Specified by:
distinct
in interfaceCriteriaQuery<T>
- Overrides:
distinct
in classAbstractQueryImpl<T>
- Parameters:
distinct
- boolean value specifying whether duplicate results must be eliminated from the query result or whether they must be retained- Returns:
- the modified query.
-
addJoin
- Specified by:
addJoin
in classAbstractQueryImpl<T>
-
getDatabaseQuery
- Specified by:
getDatabaseQuery
in classCommonAbstractCriteriaImpl<T>
-
getOrderList
Return the ordering expressions in order of precedence.- Specified by:
getOrderList
in interfaceCriteriaQuery<T>
- Returns:
- the list of ordering expressions
-
getSelection
Return the selection item of the query. This will correspond to the query type.- Specified by:
getSelection
in interfaceAbstractQuery<T>
- Returns:
- the selection item of the query
-
createCompoundQuery
Translates from the criteria query to a EclipseLink Database Query. -
createSimpleQuery
-
translate
Translates from the criteria query to a EclipseLink Database Query.- Overrides:
translate
in classCommonAbstractCriteriaImpl<T>
-