CriteriaQueryImpl (OpenJPA Parent POM 2.4.0 API)

java.lang.Object
- org.apache.openjpa.persistence.criteria.CriteriaQueryImpl<T>

All Implemented Interfaces:

javax.persistence.criteria.AbstractQuery<T>, javax.persistence.criteria.CriteriaQuery<T>, AliasContext, OpenJPACriteriaQuery<T>
```
 class CriteriaQueryImpl<T>
extends Object
implements OpenJPACriteriaQuery<T>, AliasContext
```
Criteria query implementation. Collects clauses of criteria query (e.g. select projections, from/join, where conditions, order by). Eventually translates these clauses to a similar form of Expression tree that can be interpreted and executed against a data store by OpenJPA kernel.

Since:

2.0.0

Author:

Pinaki Poddar, Fay Wang

Constructor Summary

Constructors
Constructor and Description
`CriteriaQueryImpl(MetamodelImpl model, Class<T> resultClass)`
`CriteriaQueryImpl(MetamodelImpl model, SubqueryImpl<T> delegator)` Used by a subquery to delegate to this receiver.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) void`	`addRoot(RootImpl<?> root)`
`void`	`assertRoot()`
`void`	`assertSelection()`
`OpenJPACriteriaQuery<T>`	`compile()` Compiles to verify that at least one root is defined, a selection term is present and, most importantly, collects all the parameters so that they can be bound to the executable query.
`(package private) Context`	`ctx()` Gets the current context.
`javax.persistence.criteria.CriteriaQuery<T>`	`distinct(boolean distinct)` Sets whether this query as distinct.
`boolean`	`equals(Object other)`
`<X> javax.persistence.criteria.Root<X>`	`from(Class<X> cls)`
`<X> javax.persistence.criteria.Root<X>`	`from(javax.persistence.metamodel.EntityType<X> entity)`
`String`	`getAlias(javax.persistence.criteria.Selection<?> selection)` Gets the alias of the given node.
`Map<javax.persistence.criteria.Selection<?>,String>`	`getAliases()`
`(package private) CriteriaQueryImpl<?>`	`getAncestor()` Gets either this query itself if this is not a captive query for a subquery.
`(package private) Stack<Context>`	`getContexts()` Gets the stack of contexts used by this query.
`(package private) SubqueryImpl<?>`	`getDelegator()` Gets the subquery, if any, which is delegating to this receiver.
`(package private) CriteriaQueryImpl<?>`	`getDelegatorParent()`
`List<javax.persistence.criteria.Expression<?>>`	`getGroupList()`
`PredicateImpl`	`getGroupRestriction()`
`MetamodelImpl`	`getMetamodel()` Gets the metamodel which defines the scope of all persistent entity references.
`List<javax.persistence.criteria.Order>`	`getOrderList()` Gets the list of ordering elements.
`Set<javax.persistence.criteria.ParameterExpression<?>>`	`getParameters()`
`OrderedMap<Object,Class<?>>`	`getParameterTypes()` Return map where key is the parameter expression itself and value is the expected type.
`(package private) QueryExpressions`	`getQueryExpressions(ExpressionFactory factory)` Populate a kernel expression tree by translating the components of this receiver with the help of the given `ExpressionFactory`.
`Value`	`getRegisteredRootVariable(javax.persistence.criteria.Root<?> root)` Gets the registered variable for the given root.
`Value`	`getRegisteredValue(javax.persistence.criteria.Selection<?> selection)` Gets the registered path value for the given node.
`Value`	`getRegisteredVariable(javax.persistence.criteria.Selection<?> selection)` Gets the registered variable for the given node.
`PredicateImpl`	`getRestriction()`
`Class<T>`	`getResultType()`
`javax.persistence.criteria.Root<?>`	`getRoot()`
`(package private) javax.persistence.criteria.Root<?>`	`getRoot(boolean mustExist)`
`Set<javax.persistence.criteria.Root<?>>`	`getRoots()`
`javax.persistence.criteria.Selection<T>`	`getSelection()` Return the selection of the query
`List<javax.persistence.criteria.Selection<?>>`	`getSelectionList()` Return the selection items of the query as a list
`javax.persistence.criteria.CriteriaQuery<T>`	`groupBy(javax.persistence.criteria.Expression<?>... grouping)`
`javax.persistence.criteria.CriteriaQuery<T>`	`groupBy(List<javax.persistence.criteria.Expression<?>> grouping)`
`javax.persistence.criteria.CriteriaQuery<T>`	`having(javax.persistence.criteria.Expression<Boolean> restriction)`
`javax.persistence.criteria.CriteriaQuery<T>`	`having(javax.persistence.criteria.Predicate... restrictions)`
`(package private) void`	`invalidateCompilation()`
`protected boolean`	`isDefaultProjection()`
`boolean`	`isDistinct()` Affirms if selection of this query is distinct.
`(package private) boolean`	`isMultiselect()`
`boolean`	`isRegistered(javax.persistence.criteria.Selection<?> selection)` Affirms if the given node has been registered.
`javax.persistence.criteria.CriteriaQuery<T>`	`multiselect(List<javax.persistence.criteria.Selection<?>> list)`
`javax.persistence.criteria.CriteriaQuery<T>`	`multiselect(javax.persistence.criteria.Selection<?>... selections)` Specify the items that are to be returned in the query result.
`javax.persistence.criteria.CriteriaQuery<T>`	`orderBy(List<javax.persistence.criteria.Order> orders)`
`javax.persistence.criteria.CriteriaQuery<T>`	`orderBy(javax.persistence.criteria.Order... orders)`
`(package private) void`	`registerParameter(ParameterExpressionImpl<?> p)` Registers the given parameter.
`(package private) void`	`registerRoot(javax.persistence.criteria.Root<?> root, Value var)` Registers a variable for the given root expression.
`void`	`registerVariable(javax.persistence.criteria.Selection<?> node, Value var, Value path)` Register the given variable of given path value against the given node.
`(package private) void`	`render(StringBuilder buffer, Set<javax.persistence.criteria.Root<?>> roots, List<javax.persistence.criteria.Join<?,?>> correlatedJoins)`
`javax.persistence.criteria.CriteriaQuery<T>`	`select(javax.persistence.criteria.Selection<? extends T> selection)` Specify the item that is to be returned in the query result.
`(package private) void`	`setContexts(Stack<Context> contexts)`
`<U> javax.persistence.criteria.Subquery<U>`	`subquery(Class<U> type)`
`String`	`toCQL()` Gets the string representation of the query.
`String`	`toString()` Returns a JPQL-like string, if this receiver is populated.
`javax.persistence.criteria.CriteriaQuery<T>`	`where(javax.persistence.criteria.Expression<Boolean> restriction)`
`javax.persistence.criteria.CriteriaQuery<T>`	`where(javax.persistence.criteria.Predicate... restrictions)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CriteriaQueryImpl
```
public CriteriaQueryImpl(MetamodelImpl model,
                 Class<T> resultClass)
```
  - CriteriaQueryImpl
```
CriteriaQueryImpl(MetamodelImpl model,
                 SubqueryImpl<T> delegator)
```
    Used by a subquery to delegate to this receiver.
    
    Parameters:
    model - the metamodel defines the scope of all persistent entity references.
    delegator - the subquery which will delegate to this receiver.
- Method Detail
  - getDelegator
```
SubqueryImpl<?> getDelegator()
```
    Gets the subquery, if any, which is delegating to this receiver.
  - getMetamodel
```
public MetamodelImpl getMetamodel()
```
    Gets the metamodel which defines the scope of all persistent entity references.
  - getContexts
```
Stack<Context> getContexts()
```
    Gets the stack of contexts used by this query.
  - distinct
```
public javax.persistence.criteria.CriteriaQuery<T> distinct(boolean distinct)
```
    Sets whether this query as distinct.
    
    Specified by:
    
    distinct in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    distinct in interface javax.persistence.criteria.CriteriaQuery<T>
  - getOrderList
```
public List<javax.persistence.criteria.Order> getOrderList()
```
    Gets the list of ordering elements.
    
    Specified by:
    
    getOrderList in interface javax.persistence.criteria.CriteriaQuery<T>
    
    Returns:
    Empty list if there is no ordering elements. The returned list if mutable but mutation has no impact on this query.
  - getSelection
```
public javax.persistence.criteria.Selection<T> getSelection()
```
    Return the selection of the query
    
    Specified by:
    
    getSelection in interface javax.persistence.criteria.AbstractQuery<T>
    
    Returns:
    the item to be returned in the query result
  - multiselect
```
public javax.persistence.criteria.CriteriaQuery<T> multiselect(javax.persistence.criteria.Selection<?>... selections)
```
    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
    , 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 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 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

Class CriteriaQueryImpl<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CriteriaQueryImpl

CriteriaQueryImpl

Method Detail

getDelegator

getMetamodel

getContexts

distinct

getOrderList

getSelection

multiselect

registerParameter

getParameters

getSelectionList

groupBy

groupBy

having

having

orderBy

orderBy

select

where

where

from

from

getGroupList

getGroupRestriction

getRestriction

getRoots

getRoot

getRoot

addRoot

isDistinct

subquery

getParameterTypes

getQueryExpressions

assertRoot

assertSelection

setContexts

getAncestor

getAliases

ctx

getAlias

registerVariable

isRegistered

getRegisteredVariable

getRegisteredValue

registerRoot

getRegisteredRootVariable

getDelegatorParent

getResultType

multiselect

isMultiselect

isDefaultProjection

invalidateCompilation

compile

toCQL

render

toString

equals