org.eclipse.persistence.internal.jpa.querydef

Class SubQueryImpl<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.SubQueryImpl<T>

All Implemented Interfaces:

java.io.Serializable, InternalExpression, InternalSelection

public class SubQueryImpl<T>
extends AbstractQueryImpl<T>
implements InternalExpression, InternalSelection

Purpose: Contains the implementation of the SubQuery interface of the JPA criteria API.

Description: This is the container class for the components that define a query to be used in a sub select expression.

Since:

EclipseLink 2.0

Author:

gyorke

See Also:

CriteriaQuery, SubQuery, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl

AbstractQueryImpl.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alias
protected java.util.Set<<any>>	correlatedJoins
protected java.util.Set<org.eclipse.persistence.expressions.Expression>	correlations
protected SubSelectExpression	currentNode
protected CommonAbstractCriteria	parent
protected java.util.Set<FromImpl>	processedJoins
protected SelectionImpl<?>	selection
protected ReportQuery	subQuery

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

Constructors

Constructor and Description
SubQueryImpl(Metamodel metamodel, java.lang.Class result, CriteriaBuilderImpl queryBuilder, CommonAbstractCriteria parent)

Method Summary

Modifier and Type	Method and Description
void	addJoin(FromImpl join)
void	addParameter(<any> parameter)
<any>	alias(java.lang.String name) Assign an alias to the selection.
<X> <any>	as(java.lang.Class<X> type)
<X,K,V> <any>	correlate(<any> parentMap) Correlates a join to a Map-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.
<X,Y> <any>	correlate(<any> parentJoin) Correlates a join object of the enclosing query to a join object of the subquery and returns the subquery join object.
<X,Y> <any>	correlate(<any> parentCollection) Correlates a join to a Collection-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.
<X,Y> <any>	correlate(<any> parentSet) Correlates a join to a Set-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.
<X,Y> <any>	correlate(<any> parentList) Correlates a join to a List-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.
<Y> <any>	correlate(<any> parentRoot) Correlates a root of the enclosing query to a root of the subquery and returns the subquery root.
<any>	distinct(boolean distinct) Specify whether duplicate query results will be eliminated.
void	findRootAndParameters(CommonAbstractCriteriaImpl query)
java.lang.String	getAlias()
protected org.eclipse.persistence.expressions.Expression	getBaseExpression()
java.util.List<<any>>	getCompoundSelectionItems() Return selection items composing a compound selection
CommonAbstractCriteria	getContainingQuery()
java.util.Set<<any>>	getCorrelatedJoins() Return the joins that have been made from the subquery.
org.eclipse.persistence.expressions.Expression	getCurrentNode() Returns the current EclipseLink expression at this node in the criteria expression tree
DatabaseQuery	getDatabaseQuery()
java.lang.Class<T>	getJavaType()
java.util.Set<<any>>	getParameters() Return the parameters of the query
<any>	getParent() Return the query of which this is a subquery.
<any>	getSelection() Return the selection item of the query.
<any>	groupBy(<any>... grouping) Specify the expressions that are used to form groups over the query results.
<any>	groupBy(java.util.List<<any>> grouping) Specify the expressions that are used to form groups over the query results.
<any>	having(<any> restriction) Specify a restriction over the groups of the query.
<any>	having(Predicate... restrictions) Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates.
Predicate	in(<any>... values) Apply a predicate to test whether the expression is a member of the argument list.
Predicate	in(<any> values) Apply a predicate to test whether the expression is a member of the collection.
Predicate	in(java.util.Collection<?> values) Apply a predicate to test whether the expression is a member of the collection.
Predicate	in(java.lang.Object... values)
protected void	integrateRoot(RootImpl root) Used to use a root from a different query.
protected org.eclipse.persistence.expressions.Expression	internalCorrelate(FromImpl from)
boolean	isCompoundExpression()
boolean	isCompoundSelection() Whether the selection item is a compound selection
boolean	isConstructor()
boolean	isExpression()
boolean	isFrom()
boolean	isJunction()
boolean	isLiteral()
Predicate	isNotNull()
Predicate	isNull()
boolean	isParameter()
boolean	isPredicate()
boolean	isRoot()
boolean	isSubquery()
<any>	select(<any> selection) Specify the item that is to be returned in the query result.
<any>	where(<any> restriction) Modify the query to restrict the query result according to the specified boolean expression.
<any>	where(Predicate... restrictions) 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, getGroupList, getGroupRestriction, getRoots, isDistinct

Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.CommonAbstractCriteriaImpl

getRestriction, getResultType, internalFrom, internalFrom, subquery, translate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

selection

protected SelectionImpl<?> selection

currentNode

protected SubSelectExpression currentNode

alias

protected java.lang.String alias

subQuery

protected ReportQuery subQuery

correlatedJoins

protected java.util.Set<<any>> correlatedJoins

parent

protected CommonAbstractCriteria parent

processedJoins

protected java.util.Set<FromImpl> processedJoins

correlations

protected java.util.Set<org.eclipse.persistence.expressions.Expression> correlations

Constructor Detail

SubQueryImpl

public SubQueryImpl(Metamodel metamodel,
                    java.lang.Class result,
                    CriteriaBuilderImpl queryBuilder,
                    CommonAbstractCriteria parent)

Method Detail

select

public <any> select(<any> selection)

Specify the item that is to be returned in the query result. Replaces the previously specified selection, if any.

Parameters:

selection - selection specifying the item that is to be returned in the query result

Returns:

the modified query

where

public <any> where(<any> restriction)

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.

Overrides:

where in class AbstractQueryImpl<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

where

public <any> where(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.

Overrides:

where in class AbstractQueryImpl<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

groupBy

public <any> groupBy(<any>... grouping)

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.

Overrides:

groupBy in class AbstractQueryImpl<T>

Parameters:

grouping - zero or more grouping expressions

Returns:

the modified query

groupBy

public <any> groupBy(java.util.List<<any>> grouping)

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.

Overrides:

groupBy in class AbstractQueryImpl<T>

Parameters:

grouping - zero or more grouping expressions

Returns:

the modified query

having

public <any> having(<any> restriction)

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.

Overrides:

having in class AbstractQueryImpl<T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified query

having

public <any> having(Predicate... restrictions)

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.

Overrides:

having in class AbstractQueryImpl<T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified query

correlate

public <Y> <any> correlate(<any> parentRoot)

Correlates a root of the enclosing query to a root of the subquery and returns the subquery root.

Parameters:

parentRoot - a root of the containing query

Returns:

subquery root

correlate

public <X,Y> <any> correlate(<any> parentJoin)

Correlates a join object of the enclosing query to a join object of the subquery and returns the subquery join object.

Parameters:

parentJoin - join target of the containing query

Returns:

subquery join

correlate

public <X,Y> <any> correlate(<any> parentCollection)

Correlates a join to a Collection-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.

Parameters:

parentCollection - join target of the containing query

Returns:

subquery join

correlate

public <X,Y> <any> correlate(<any> parentSet)

Correlates a join to a Set-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.

Parameters:

parentSet - join target of the containing query

Returns:

subquery join

correlate

public <X,Y> <any> correlate(<any> parentList)

Correlates a join to a List-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.

Parameters:

parentList - join target of the containing query

Returns:

subquery join

correlate

public <X,K,V> <any> correlate(<any> parentMap)

Correlates a join to a Map-valued association or element collection in the enclosing query to a join object of the subquery and returns the subquery join object.

Parameters:

parentMap - join target of the containing query

Returns:

subquery join

internalCorrelate

protected org.eclipse.persistence.expressions.Expression internalCorrelate(FromImpl from)

getParameters

public java.util.Set<<any>> getParameters()

Description copied from class: CommonAbstractCriteriaImpl

Return the parameters of the query

Overrides:

getParameters in class CommonAbstractCriteriaImpl<T>

Returns:

the query parameters

getParent

public <any> getParent()

Return the query of which this is a subquery.

Returns:

the enclosing query or subquery

distinct

public <any> distinct(boolean 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.

Overrides:

distinct in class AbstractQueryImpl<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.

getCurrentNode

public org.eclipse.persistence.expressions.Expression getCurrentNode()

Returns the current EclipseLink expression at this node in the criteria expression tree

Specified by:

getCurrentNode in interface InternalSelection

Returns:

the currentNode

getSelection

public <any> getSelection()

Return the selection item of the query. This will correspond to the query type.

Returns:

the selection item of the query

getCorrelatedJoins

public java.util.Set<<any>> getCorrelatedJoins()

Return the joins that have been made from the subquery.

Returns:

joins made from this type

addParameter

public void addParameter(<any> parameter)

Overrides:

addParameter in class CommonAbstractCriteriaImpl<T>

addJoin

public void addJoin(FromImpl join)

Specified by:

addJoin in class AbstractQueryImpl<T>

as

public <X> <any> as(java.lang.Class<X> type)

in

public Predicate in(java.lang.Object... values)

in

public Predicate in(<any>... values)

Apply a predicate to test whether the expression is a member of the argument list.

Parameters:

values -

Returns:

predicate testing for membership

in

public Predicate in(java.util.Collection<?> values)

Apply a predicate to test whether the expression is a member of the collection.

Parameters:

values - collection

Returns:

predicate testing for membership

in

public Predicate in(<any> values)

Apply a predicate to test whether the expression is a member of the collection.

Parameters:

values - expression corresponding to collection

Returns:

predicate testing for membership

isNotNull

public Predicate isNotNull()

isNull

public Predicate isNull()

alias

public <any> alias(java.lang.String name)

Assign an alias to the selection.

Parameters:

name - alias

getAlias

public java.lang.String getAlias()

getJavaType

public java.lang.Class<T> getJavaType()

getCompoundSelectionItems

public java.util.List<<any>> getCompoundSelectionItems()

Return selection items composing a compound selection

Returns:

list of selection items

Throws:

java.lang.IllegalStateException - if selection is not a compound selection

isCompoundSelection

public boolean isCompoundSelection()

Whether the selection item is a compound selection

Returns:

boolean

isConstructor

public boolean isConstructor()

Specified by:

isConstructor in interface InternalSelection

isJunction

public boolean isJunction()

Specified by:

isJunction in interface InternalExpression

isPredicate

public boolean isPredicate()

Specified by:

isPredicate in interface InternalExpression

isParameter

public boolean isParameter()

Specified by:

isParameter in interface InternalExpression

isRoot

public boolean isRoot()

Specified by:

isRoot in interface InternalSelection

isSubquery

public boolean isSubquery()

Specified by:

isSubquery in interface InternalExpression

integrateRoot

protected void integrateRoot(RootImpl root)

Description copied from class: CommonAbstractCriteriaImpl

Used to use a root from a different query.

Overrides:

integrateRoot in class AbstractQueryImpl<T>

isCompoundExpression

public boolean isCompoundExpression()

Specified by:

isCompoundExpression in interface InternalExpression

isExpression

public boolean isExpression()

Specified by:

isExpression in interface InternalExpression

isFrom

public boolean isFrom()

Specified by:

isFrom in interface InternalSelection

isLiteral

public boolean isLiteral()

Specified by:

isLiteral in interface InternalExpression

findRootAndParameters

public void findRootAndParameters(CommonAbstractCriteriaImpl query)

Specified by:

findRootAndParameters in interface InternalSelection

Overrides:

findRootAndParameters in class AbstractQueryImpl<T>

getBaseExpression

protected org.eclipse.persistence.expressions.Expression getBaseExpression()

Overrides:

getBaseExpression in class AbstractQueryImpl<T>

getContainingQuery

public CommonAbstractCriteria getContainingQuery()

getDatabaseQuery

public DatabaseQuery getDatabaseQuery()

Specified by:

getDatabaseQuery in class CommonAbstractCriteriaImpl<T>