Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.expressions

Class SubSelectExpression

java.lang.Object

org.eclipse.persistence.expressions.Expression

org.eclipse.persistence.internal.expressions.BaseExpression

org.eclipse.persistence.internal.expressions.SubSelectExpression

All Implemented Interfaces:

Serializable, Cloneable

public class SubSelectExpression
extends BaseExpression

This is used to support subselects. The subselect represents a mostly independent (has own expression builder) query using a report query. Subselects can be used for, in (single column), exists (empty or non-empty), comparisons (single value).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	attribute
protected Expression	criteriaBase
protected boolean	hasBeenNormalized
protected Class<?>	returnType
protected ReportQuery	subQuery

Fields inherited from class org.eclipse.persistence.internal.expressions.BaseExpression

baseExpression, builder

Fields inherited from class org.eclipse.persistence.expressions.Expression

currentAlias, hashCode, lastTable, selectIfOrderedBy, shouldUseUpperCaseForIgnoreCase

Constructor Summary

Constructors

Constructor	Description
SubSelectExpression()
SubSelectExpression(ReportQuery query, Expression baseExpression)

Method Summary

Modifier and Type	Method	Description
static SubSelectExpression	createSubSelectExpressionForCount(Expression outerQueryBaseExpression, Expression outerQueryCriteria, String attribute, Class<?> returnType)	INTERNAL: This factory method is used to build a subselect that will do a count.
String	descriptionOfNodeType()	INTERNAL: Used in debug printing of this node.
boolean	equals(Object object)	INTERNAL: Return if the expression is equal to the other.
ReportQuery	getSubQuery()
protected void	initializeCountSubQuery()	INTERNAL: This method creates a report query that counts the number of values in baseExpression.anyOf(attribute) For most queries, a ReportQuery will be created that does a simple count using an anonymous query.
boolean	isSubSelectExpression()	INTERNAL:
void	iterateOn(ExpressionIterator iterator)	INTERNAL: For iterating using an inner class
Expression	normalize(ExpressionNormalizer normalizer)	INTERNAL: The subquery must be normalized with the knowledge of the outer statement for outer references and correct aliasing.
Expression	normalizeSubSelect(ExpressionNormalizer normalizer, Map clonedExpressions)	INTERNAL: Normalize this expression now that the parent statement has been normalized.
protected void	postCopyIn(Map alreadyDone)	The query must be cloned, and the sub-expression must be cloned using the same outer expression identity.
protected void	printCustomSQL(ExpressionSQLPrinter printer)	Print the sub query to the printer.
void	printSQL(ExpressionSQLPrinter printer)	Print the sub query to the printer.
Expression	rebuildOn(Expression newBase)	Should not rebuild as has its on expression builder.
void	resetPlaceHolderBuilder(ExpressionBuilder queryBuilder)	INTERNAL: Search the tree for any expressions (like SubSelectExpressions) that have been built using a builder that is not attached to the query.
void	setSubQuery(ReportQuery subQuery)
Expression	twistedForBaseAndContext(Expression newBase, Expression context, Expression oldBase)	INTERNAL: Rebuild myself against the base, with the values of parameters supplied by the context expression.
void	writeDescriptionOn(BufferedWriter writer)	INTERNAL: Used to print a debug form of the expression tree.
void	writeFields(ExpressionSQLPrinter printer, List<DatabaseField> newFields, SQLSelectStatement statement)	INTERNAL: called from SQLSelectStatement.writeFieldsFromExpression(...) This allows a sub query in the select clause.
void	writeSubexpressionsTo(BufferedWriter writer, int indent)	INTERNAL: Used in SQL printing.

Methods inherited from class org.eclipse.persistence.internal.expressions.BaseExpression

getBaseExpression, getBuilder, setBaseExpression, shallowClone

Methods inherited from class org.eclipse.persistence.expressions.Expression

addDate, addDate, addMonths, addMonths, alias, aliasForTable, all, all, all, all, all, all, all, all, all, all, all, all, allOf, and, any, any, any, any, any, any, any, any, any, any, any, any, anyOf, anyOf, anyOfAllowingNone, anyOfAllowingNone, as, ascending, asciiValue, asOf, assignAlias, assignTableAliasesStartingAt, average, between, between, between, between, between, between, between, between, between, caseConditionStatement, caseConditionStatement, caseStatement, caseStatement, cast, clone, cloneUsing, coalesce, coalesce, computeHashCode, concat, containsAllKeyWords, containsAnyKeyWords, containsSubstring, containsSubstring, containsSubstringIgnoringCase, containsSubstringIgnoringCase, convertNodeToUseOuterJoin, convertToUseOuterJoin, copiedVersionFrom, count, create, create, createWithBaseLast, currentDate, currentDateDate, currentTime, currentTimeStamp, dateDifference, dateDifference, dateName, datePart, dateToString, decode, descending, difference, distinct, doesConform, doesConform, equal, equal, equal, equal, equal, equal, equal, equal, equal, equal, equalOuterJoin, equalOuterJoin, equalsIgnoreCase, equalsIgnoreCase, except, except, exceptAll, exceptAll, exists, existsNode, extract, extractFields, extractPrimaryKeyValues, extractValue, extractValues, extractXml, from, fromConstant, fromLiteral, get, get, getAlias, getAllowingNull, getAsOfClause, getAsOfClauseRecursively, getClonedField, getField, getField, getFields, getFieldValue, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getLeafDescriptor, getLeafMapping, getName, getNumberVal, getOperator, getOperator, getOwnedTables, getParameter, getParameter, getParameter, getProperty, getSelectionFields, getSelectionFields, getSession, getStringVal, getTable, getTable, getTableAliases, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, hasAsOfClause, hasBeenAliased, hashCode, hexToRaw, ifNull, in, in, in, in, in, in, in, in, in, in, in, in, index, indexOf, intersect, intersect, intersectAll, intersectAll, isClassTypeExpression, isCompoundExpression, isConstantExpression, isDataExpression, isEmpty, isExpressionBuilder, isFieldExpression, isFragment, isFunctionExpression, isLiteralExpression, isLogicalExpression, isMapEntryExpression, isNull, isObjectExpression, isParameterExpression, isQueryKeyExpression, isRelationExpression, isTableExpression, isTreatExpression, isValueExpression, join, lastDay, leftJoin, leftPad, leftPad, leftTrim, leftTrim, length, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, lessThanEqual, like, like, like, like, likeIgnoreCase, likeIgnoreCase, literal, localDate, localDateTime, localTime, locate, locate, locate, mapEntry, mapKey, maximum, minimum, monthsBetween, newTime, nextDay, noneOf, not, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notEmpty, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notExists, notIn, notIn, notIn, notIn, notIn, notIn, notIn, notIn, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notNull, nullIf, nullsFirst, nullsLast, operator, or, performOperator, postfixSQL, prefixSQL, printJava, ref, regexp, regexp, registerIn, replace, replicate, replicate, resetCache, reverse, right, right, rightPad, rightPad, rightTrim, rightTrim, roundDate, selectIfOrderedBy, setLocalBase, setSelectIfOrderedBy, size, size, some, some, some, some, some, some, some, some, some, some, some, some, sql, standardDeviation, subQuery, substring, substring, substring, substring, sum, toChar, toChar, toCharacter, toDate, toLowerCase, toNumber, toString, toString, toUpperCase, toUppercaseCasedWords, translate, treat, trim, trim, truncateDate, twist, type, union, union, unionAll, unionAll, validateNode, value, value, value, value, value, value, value, value, value, value, valueFromObject, valueFromObject, variance, writeAlias, writeField

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

hasBeenNormalized

protected boolean hasBeenNormalized

subQuery

protected ReportQuery subQuery

attribute

protected String attribute

returnType

protected Class<?> returnType

criteriaBase

protected Expression criteriaBase

Constructor Details

SubSelectExpression

public SubSelectExpression()

SubSelectExpression

public SubSelectExpression(ReportQuery query,
 Expression baseExpression)

Method Details

equals

public boolean equals(Object object)

INTERNAL: Return if the expression is equal to the other. This is used to allow dynamic expression's SQL to be cached.

Overrides:

equals in class Expression

descriptionOfNodeType

public String descriptionOfNodeType()

INTERNAL: Used in debug printing of this node.

Overrides:

descriptionOfNodeType in class Expression

getSubQuery

public ReportQuery getSubQuery()

initializeCountSubQuery

protected void initializeCountSubQuery()

INTERNAL: This method creates a report query that counts the number of values in baseExpression.anyOf(attribute) For most queries, a ReportQuery will be created that does a simple count using an anonymous query. In the case of a DirectCollectionMapping, the ReportQuery will use the baseExpression to create a join to the table containing the Direct fields and count based on that join.

isSubSelectExpression

public boolean isSubSelectExpression()

INTERNAL:

Overrides:

isSubSelectExpression in class Expression

iterateOn

public void iterateOn(ExpressionIterator iterator)

INTERNAL: For iterating using an inner class

Overrides:

iterateOn in class Expression

normalize

public Expression normalize(ExpressionNormalizer normalizer)

INTERNAL: The subquery must be normalized with the knowledge of the outer statement for outer references and correct aliasing. For CR#4223 it will now be normalized after the outer statement is, rather than somewhere in the middle of the outer statement's normalize.

Overrides:

normalize in class Expression

normalizeSubSelect

public Expression normalizeSubSelect(ExpressionNormalizer normalizer,
 Map clonedExpressions)

INTERNAL: Normalize this expression now that the parent statement has been normalized. For CR#4223

postCopyIn

protected void postCopyIn(Map alreadyDone)

The query must be cloned, and the sub-expression must be cloned using the same outer expression identity.

Overrides:

postCopyIn in class BaseExpression

printCustomSQL

protected void printCustomSQL(ExpressionSQLPrinter printer)

Print the sub query to the printer.

printSQL

public void printSQL(ExpressionSQLPrinter printer)

Print the sub query to the printer.

Specified by:

printSQL in class Expression

rebuildOn

public Expression rebuildOn(Expression newBase)

Should not rebuild as has its on expression builder.

Specified by:

rebuildOn in class Expression

See Also:

• Expression.cloneUsing(Expression newBase)

resetPlaceHolderBuilder

public void resetPlaceHolderBuilder(ExpressionBuilder queryBuilder)

INTERNAL: Search the tree for any expressions (like SubSelectExpressions) that have been built using a builder that is not attached to the query. This happens in case of an Exists call using a new ExpressionBuilder(). This builder needs to be replaced with one from the query.

Overrides:

resetPlaceHolderBuilder in class BaseExpression

setSubQuery

public void setSubQuery(ReportQuery subQuery)

twistedForBaseAndContext

public Expression twistedForBaseAndContext(Expression newBase,
 Expression context,
 Expression oldBase)

Description copied from class: Expression

INTERNAL: Rebuild myself against the base, with the values of parameters supplied by the context expression. This is used for transforming a standalone expression (e.g. the join criteria of a mapping) into part of some larger expression. You normally would not call this directly, instead calling twist See the comment there for more details"

Overrides:

twistedForBaseAndContext in class Expression

writeDescriptionOn

public void writeDescriptionOn(BufferedWriter writer)
                        throws IOException

INTERNAL: Used to print a debug form of the expression tree.

Overrides:

writeDescriptionOn in class Expression

Throws:

IOException

writeSubexpressionsTo

public void writeSubexpressionsTo(BufferedWriter writer,
 int indent)
                           throws IOException

INTERNAL: Used in SQL printing.

Overrides:

writeSubexpressionsTo in class Expression

Throws:

IOException

writeFields

public void writeFields(ExpressionSQLPrinter printer,
 List<DatabaseField> newFields,
 SQLSelectStatement statement)

INTERNAL: called from SQLSelectStatement.writeFieldsFromExpression(...) This allows a sub query in the select clause.

Overrides:

writeFields in class Expression

createSubSelectExpressionForCount

public static SubSelectExpression createSubSelectExpressionForCount(Expression outerQueryBaseExpression,
 Expression outerQueryCriteria,
 String attribute,
 Class<?> returnType)

INTERNAL: This factory method is used to build a subselect that will do a count. It will count the number of items in baseExpression.anyOf(attribute).