SubqueryImpl (OpenJPA Parent POM 2.2.2 API)

java.lang.Object
- org.apache.openjpa.persistence.criteria.SelectionImpl<X>
- - org.apache.openjpa.persistence.criteria.ExpressionImpl<T>
  - - org.apache.openjpa.persistence.criteria.SubqueryImpl<T>

Type Parameters:
T - the type selected by this subquery.

All Implemented Interfaces:

javax.persistence.criteria.AbstractQuery<T>, javax.persistence.criteria.Expression<T>, javax.persistence.criteria.Selection<T>, javax.persistence.criteria.Subquery<T>, javax.persistence.TupleElement<T>, CriteriaExpression
```
 class SubqueryImpl<T>
extends ExpressionImpl<T>
implements javax.persistence.criteria.Subquery<T>
```
Subquery is an expression which itself is a query and always appears in the context of a parent query. A subquery delegates to a captive query for most of the operations but also maintains its own joins and correlated joins.

Since:

2.0.0

Author:

Pinaki Poddar, Fay Wang

Constructor Summary

Constructors
Constructor and Description
`SubqueryImpl(Class<T> cls, javax.persistence.criteria.AbstractQuery<?> parent)` Construct a subquery always in the context of a parent query.

Method Summary

Methods
Modifier and Type	Method and Description
`StringBuilder`	`asValue(AliasContext q)` Get a string representation of this node as a value in the context of the given query.
`StringBuilder`	`asVariable(AliasContext q)` Get a string representation of this node as a variable in the context of the given query.
`<X,Y> javax.persistence.criteria.CollectionJoin<X,Y>`	`correlate(javax.persistence.criteria.CollectionJoin<X,Y> parentJoin)`
`<X,Y> javax.persistence.criteria.Join<X,Y>`	`correlate(javax.persistence.criteria.Join<X,Y> parentJoin)` Correlate this subquery with the given join.
`<X,Y> javax.persistence.criteria.ListJoin<X,Y>`	`correlate(javax.persistence.criteria.ListJoin<X,Y> parentJoin)`
`<X,K,V> javax.persistence.criteria.MapJoin<X,K,V>`	`correlate(javax.persistence.criteria.MapJoin<X,K,V> parentJoin)`
`<Y> javax.persistence.criteria.Root<Y>`	`correlate(javax.persistence.criteria.Root<Y> root)` Correlate this subquery with the given root.
`<X,Y> javax.persistence.criteria.SetJoin<X,Y>`	`correlate(javax.persistence.criteria.SetJoin<X,Y> parentJoin)`
`javax.persistence.criteria.Subquery<T>`	`distinct(boolean distinct)`
`<X> javax.persistence.criteria.Root<X>`	`from(Class<X> entityClass)`
`<X> javax.persistence.criteria.Root<X>`	`from(javax.persistence.metamodel.EntityType<X> entity)`
`(package private) Stack<Context>`	`getContexts()`
`Set<javax.persistence.criteria.Join<?,?>>`	`getCorrelatedJoins()`
`(package private) CriteriaQueryImpl<T>`	`getDelegate()` Gets the captive query to which this subquery delegates.
`List<javax.persistence.criteria.Expression<?>>`	`getGroupList()`
`javax.persistence.criteria.Predicate`	`getGroupRestriction()`
`CriteriaQueryImpl<?>`	`getInnermostParent()` Gets the 'root' query for this subquery.
`MetamodelImpl`	`getMetamodel()`
`javax.persistence.criteria.AbstractQuery<?>`	`getParent()` Gets the parent query of this subquery.
`javax.persistence.criteria.Predicate`	`getRestriction()`
`Class<T>`	`getResultType()`
`javax.persistence.criteria.Root<?>`	`getRoot()`
`Set<javax.persistence.criteria.Root<?>>`	`getRoots()`
`javax.persistence.criteria.Expression<T>`	`getSelection()`
`(package private) Subquery`	`getSubQ()`
`javax.persistence.criteria.Subquery<T>`	`groupBy(javax.persistence.criteria.Expression<?>... grouping)`
`javax.persistence.criteria.Subquery<T>`	`groupBy(List<javax.persistence.criteria.Expression<?>> grouping)`
`javax.persistence.criteria.Subquery<T>`	`having(javax.persistence.criteria.Expression<Boolean> restriction)`
`javax.persistence.criteria.Subquery<T>`	`having(javax.persistence.criteria.Predicate... restrictions)`
`boolean`	`isCorrelated()` Affirms if this is a correlated subquery.
`boolean`	`isDistinct()`
`javax.persistence.criteria.Subquery<T>`	`select(javax.persistence.criteria.Expression<T> expression)`
`<U> javax.persistence.criteria.Subquery<U>`	`subquery(Class<U> type)`
`Value`	`toValue(ExpressionFactory factory, CriteriaQueryImpl<?> q)` Convert this path to a kernel path value.
`javax.persistence.criteria.Subquery<T>`	`where(javax.persistence.criteria.Expression<Boolean> restriction)`
`javax.persistence.criteria.Subquery<T>`	`where(javax.persistence.criteria.Predicate... restrictions)`

Methods inherited from class org.apache.openjpa.persistence.criteria.ExpressionImpl
as, in, in, in, in, isNotNull, isNull, toKernelExpression

Methods inherited from class org.apache.openjpa.persistence.criteria.SelectionImpl
acceptVisit, alias, asProjection, assertValidName, getAlias, getCompoundSelectionItems, getJavaType, isAliased, isAutoAliased, isCompoundSelection, setAutoAlias

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

Methods inherited from interface javax.persistence.criteria.Expression
as, in, in, in, in, isNotNull, isNull

Methods inherited from interface javax.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType

- Constructor Detail
  - SubqueryImpl
```
SubqueryImpl(Class<T> cls,
            javax.persistence.criteria.AbstractQuery<?> parent)
```
    Construct a subquery always in the context of a parent query.
    
    Parameters:
    cls - the result type of this subquery
    parent - the non-null parent query which itself can be a subquery.
- Method Detail
  - getParent
```
public javax.persistence.criteria.AbstractQuery<?> getParent()
```
    Gets the parent query of this subquery. Can be a query or another subquery.
    
    Specified by:
    
    getParent in interface javax.persistence.criteria.Subquery<T>
  - getDelegate
```
CriteriaQueryImpl<T> getDelegate()
```
    Gets the captive query to which this subquery delegates.
  - getMetamodel
```
public MetamodelImpl getMetamodel()
```
  - getContexts
```
Stack<Context> getContexts()
```
  - getInnermostParent
```
public CriteriaQueryImpl<?> getInnermostParent()
```
    Gets the 'root' query for this subquery.
  - select
```
public javax.persistence.criteria.Subquery<T> select(javax.persistence.criteria.Expression<T> expression)
```
    Specified by:
    
    select in interface javax.persistence.criteria.Subquery<T>
  - getSelection
```
public javax.persistence.criteria.Expression<T> getSelection()
```
    Specified by:
    
    getSelection in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    getSelection in interface javax.persistence.criteria.Subquery<T>
  - from
```
public <X> javax.persistence.criteria.Root<X> from(javax.persistence.metamodel.EntityType<X> entity)
```
    Specified by:
    
    from in interface javax.persistence.criteria.AbstractQuery<T>
  - from
```
public <X> javax.persistence.criteria.Root<X> from(Class<X> entityClass)
```
    Specified by:
    
    from in interface javax.persistence.criteria.AbstractQuery<T>
  - getRoots
```
public Set<javax.persistence.criteria.Root<?>> getRoots()
```
    Specified by:
    
    getRoots in interface javax.persistence.criteria.AbstractQuery<T>
  - getRoot
```
public javax.persistence.criteria.Root<?> getRoot()
```
  - where
```
public javax.persistence.criteria.Subquery<T> where(javax.persistence.criteria.Expression<Boolean> restriction)
```
    Specified by:
    
    where in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    where in interface javax.persistence.criteria.Subquery<T>
  - where
```
public javax.persistence.criteria.Subquery<T> where(javax.persistence.criteria.Predicate... restrictions)
```
    Specified by:
    
    where in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    where in interface javax.persistence.criteria.Subquery<T>
  - groupBy
```
public javax.persistence.criteria.Subquery<T> groupBy(javax.persistence.criteria.Expression<?>... grouping)
```
    Specified by:
    
    groupBy in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    groupBy in interface javax.persistence.criteria.Subquery<T>
  - groupBy
```
public javax.persistence.criteria.Subquery<T> groupBy(List<javax.persistence.criteria.Expression<?>> grouping)
```
    Specified by:
    
    groupBy in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    groupBy in interface javax.persistence.criteria.Subquery<T>
  - having
```
public javax.persistence.criteria.Subquery<T> having(javax.persistence.criteria.Expression<Boolean> restriction)
```
    Specified by:
    
    having in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    having in interface javax.persistence.criteria.Subquery<T>
  - having
```
public javax.persistence.criteria.Subquery<T> having(javax.persistence.criteria.Predicate... restrictions)
```
    Specified by:
    
    having in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    having in interface javax.persistence.criteria.Subquery<T>
  - distinct
```
public javax.persistence.criteria.Subquery<T> distinct(boolean distinct)
```
    Specified by:
    
    distinct in interface javax.persistence.criteria.AbstractQuery<T>
    
    Specified by:
    
    distinct in interface javax.persistence.criteria.Subquery<T>
  - getGroupList
```
public List<javax.persistence.criteria.Expression<?>> getGroupList()
```
    Specified by:
    
    getGroupList in interface javax.persistence.criteria.AbstractQuery<T>
  - getRestriction
```
public javax.persistence.criteria.Predicate getRestriction()
```
    Specified by:
    
    getRestriction in interface javax.persistence.criteria.AbstractQuery<T>
  - getGroupRestriction
```
public javax.persistence.criteria.Predicate getGroupRestriction()
```
    Specified by:
    
    getGroupRestriction in interface javax.persistence.criteria.AbstractQuery<T>
  - isDistinct
```
public boolean isDistinct()
```
    Specified by:
    
    isDistinct in interface javax.persistence.criteria.AbstractQuery<T>
  - subquery
```
public <U> javax.persistence.criteria.Subquery<U> subquery(Class<U> type)
```
    Specified by:
    
    subquery in interface javax.persistence.criteria.AbstractQuery<T>
  - correlate
```
public <Y> javax.persistence.criteria.Root<Y> correlate(javax.persistence.criteria.Root<Y> root)
```
    Correlate this subquery with the given root.
    
    Specified by:
    
    correlate in interface javax.persistence.criteria.Subquery<T>
  - getCorrelatedJoins
```
public Set<javax.persistence.criteria.Join<?,?>> getCorrelatedJoins()
```
    Specified by:
    
    getCorrelatedJoins in interface javax.persistence.criteria.Subquery<T>
  - correlate
```
public <X,Y> javax.persistence.criteria.Join<X,Y> correlate(javax.persistence.criteria.Join<X,Y> parentJoin)
```
    Correlate this subquery with the given join.
    
    Specified by:
    
    correlate in interface javax.persistence.criteria.Subquery<T>
  - isCorrelated
```
public boolean isCorrelated()
```
    Affirms if this is a correlated subquery.
  - correlate
```
public <X,Y> javax.persistence.criteria.CollectionJoin<X,Y> correlate(javax.persistence.criteria.CollectionJoin<X,Y> parentJoin)
```
    Specified by:
    
    correlate in interface javax.persistence.criteria.Subquery<T>
  - correlate
```
public <X,Y> javax.persistence.criteria.SetJoin<X,Y> correlate(javax.persistence.criteria.SetJoin<X,Y> parentJoin)
```
    Specified by:
    
    correlate in interface javax.persistence.criteria.Subquery<T>
  - correlate
```
public <X,Y> javax.persistence.criteria.ListJoin<X,Y> correlate(javax.persistence.criteria.ListJoin<X,Y> parentJoin)
```
    Specified by:
    
    correlate in interface javax.persistence.criteria.Subquery<T>
  - correlate
```
public <X,K,V> javax.persistence.criteria.MapJoin<X,K,V> correlate(javax.persistence.criteria.MapJoin<X,K,V> parentJoin)
```
    Specified by:
    
    correlate in interface javax.persistence.criteria.Subquery<T>
  - getSubQ
```
Subquery getSubQ()
```
  - toValue
```
public Value toValue(ExpressionFactory factory,
            CriteriaQueryImpl<?> q)
```
    Convert this path to a kernel path value.
    
    Specified by:
    
    toValue in class ExpressionImpl<T>
    
    Parameters:
    factory - creates the kernel expression
    q - the query definition context of this expression
    
    Returns:
    an equivalent kernel value
  - getResultType
```
public Class<T> getResultType()
```
    Specified by:
    
    getResultType in interface javax.persistence.criteria.AbstractQuery<T>
  - asValue
```
public StringBuilder asValue(AliasContext q)
```
    Description copied from interface: CriteriaExpression
    
    Get a string representation of this node as a value in the context of the given query.
    
    Specified by:
    
    asValue in interface CriteriaExpression
    
    Overrides:
    
    asValue in class SelectionImpl<T>
  - asVariable
```
public StringBuilder asVariable(AliasContext q)
```
    Description copied from interface: CriteriaExpression
    
    Get a string representation of this node as a variable in the context of the given query.
    
    Specified by:
    
    asVariable in interface CriteriaExpression
    
    Overrides:
    
    asVariable in class SelectionImpl<T>

Class SubqueryImpl<T>

Constructor Summary

Method Summary

Methods inherited from class org.apache.openjpa.persistence.criteria.ExpressionImpl

Methods inherited from class org.apache.openjpa.persistence.criteria.SelectionImpl

Methods inherited from class java.lang.Object

Methods inherited from interface javax.persistence.criteria.Expression

Methods inherited from interface javax.persistence.criteria.Selection

Methods inherited from interface javax.persistence.TupleElement

Constructor Detail

SubqueryImpl

Method Detail

getParent

getDelegate

getMetamodel

getContexts

getInnermostParent

select

getSelection

from

from

getRoots

getRoot

where

where

groupBy

groupBy

having

having

distinct

getGroupList

getRestriction

getGroupRestriction

isDistinct

subquery

correlate

getCorrelatedJoins

correlate

isCorrelated

correlate

correlate

correlate

correlate

getSubQ

toValue

getResultType

asValue

asVariable