org.eclipse.persistence.internal.expressions

Class TreatAsExpression

java.lang.Object

org.eclipse.persistence.expressions.Expression

org.eclipse.persistence.internal.expressions.BaseExpression

org.eclipse.persistence.internal.expressions.DataExpression

org.eclipse.persistence.internal.expressions.ObjectExpression

org.eclipse.persistence.internal.expressions.QueryKeyExpression

org.eclipse.persistence.internal.expressions.TreatAsExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TreatAsExpression
extends QueryKeyExpression

Author:

cdelahun

See Also:

Serialized Form

Field Summary

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

derivedExpressions

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

shouldUseUpperCaseForIgnoreCase

Constructor Summary

Constructors

Constructor and Description
TreatAsExpression(java.lang.Class castClass, ObjectExpression baseExpression)

Method Summary

Modifier and Type	Method and Description
Expression	additionalTreatExpressionCriteria() INTERNAL: Return the expression to join the main table of this node to any auxiliary tables.
java.util.Map	additionalTreatExpressionCriteriaMap() INTERNAL: Used in case outer joins should be printed in FROM clause.
DatabaseTable	aliasForTable(DatabaseTable table) INTERNAL: Find the alias for a given table
int	assignTableAliasesStartingAt(int initialValue) INTERNAL: Assign aliases to any tables which I own.
ClassDescriptor	convertToCastDescriptor(ClassDescriptor rootDescriptor, AbstractSession session) INTERNAL - Return the descriptor which contains this query key, look in the inheritance hierarchy of rootDescriptor for the descriptor.
Expression	convertToUseOuterJoin() INTERNAL: Modify this expression to use outer joins wherever there are equality operations between two field nodes.
java.lang.String	descriptionOfNodeType() INTERNAL: Used for debug printing.
boolean	equals(java.lang.Object object) INTERNAL: Return if the expression is equal to the other.
java.util.List<DatabaseTable>	getAdditionalTables() INTERNAL: Return any additional tables that belong to this expression An example of how this method is used is to return any tables that belong to the map key when this expression traverses a mapping that uses a Map
Expression	getAlias(Expression subSelect) ADVANCED: Return an expression representing a sub-select in the from clause.
ClassDescriptor	getDescriptor()
java.util.Vector	getFields() INTERNAL: Return all the fields
java.lang.Object	getFieldValue(java.lang.Object objectValue, AbstractSession session) INTERNAL: Transform the object-level value into a database-level value
ClassDescriptor	getLeafDescriptor(DatabaseQuery query, ClassDescriptor rootDescriptor, AbstractSession session) INTERNAL: Lookup the descriptor for this item by traversing its expression recursively.
DatabaseMapping	getLeafMapping(DatabaseQuery query, ClassDescriptor rootDescriptor, AbstractSession session) INTERNAL: Lookup the mapping for this item by traversing its expression recursively.
java.util.List<DatabaseTable>	getOwnedSubTables() INTERNAL: much like getOwnedTables(), this gets the tables represented from the descriptor.
java.util.List<DatabaseTable>	getOwnedTables() This owns (can access) the child's extra tables as well as its parent's tables so we should pull these from super (which gets them from the current descriptor)
DatabaseTable	getReferenceTable() Calculate the reference table for based on the various QueryKeyExpression usages (join query keys, custom defined query keys, or query keys for mappings).
DatabaseTable	getRelationTable() Calculate the relation table for based on the various QueryKeyExpression usages (join query keys, custom defined query keys, or query keys for mappings).
DatabaseTable	getSourceTable() Calculate the source table for based on the various QueryKeyExpression usages (join query keys, custom defined query keys, or query keys for mappings).
TableAliasLookup	getTableAliases() INTERNAL: Return the aliases used.
Expression	getTreatCriteria() INTERNAL: this returns a single expression to represent the join from the main table to all child descriptor tables Only if outer joins should be printed in the where clause
Expression	getTypeClause()
boolean	hasAsOfClause() ADVANCED: Answers true if this is to be queried as of a past time.
boolean	isDowncast() INTERNAL:
boolean	isTreatExpression() INTERNAL:
Expression	mappingCriteria(Expression base)
Expression	normalize(ExpressionNormalizer normalizer, Expression base, java.util.List<Expression> foreignKeyJoinPointer) INTERNAL: For CR#2456 if this is part of an objExp.equal(objExp), do not need to add additional expressions to normalizer both times, and the foreign key join replaces the equal expression.
void	printJava(ExpressionJavaPrinter printer) INTERNAL: Print java for project class generation
void	printSQL(ExpressionSQLPrinter printer) INTERNAL: Print SQL onto the stream, using the ExpressionPrinter for context
Expression	rebuildOn(Expression newBase) INTERNAL: This expression is built on a different base than the one we want.
boolean	selectIfOrderedBy() PUBLIC: Return whether this expression should be included in the SELECT clause if it is used in an ORDER BY clause
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	validateNode() Do any required validation for this node.
java.lang.Object	valueFromObject(java.lang.Object object, AbstractSession session, AbstractRecord translationRow, int valueHolderPolicy) INTERNAL: Return the value for in memory comparison.
java.lang.Object	valueFromObject(java.lang.Object object, AbstractSession session, AbstractRecord translationRow, int valueHolderPolicy, boolean isObjectUnregistered) INTERNAL: Return the value for in memory comparison.
void	writeDescriptionOn(java.io.BufferedWriter writer) INTERNAL: Used to print a debug form of the expression tree.
void	writeFields(ExpressionSQLPrinter printer, java.util.Vector newFields, SQLSelectStatement statement) INTERNAL: called from SQLSelectStatement.writeFieldsFromExpression(...)
void	writeSubexpressionsTo(java.io.BufferedWriter writer, int indent) Print the base for debuggin purposes.

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

additionalExpressionCriteria, additionalExpressionCriteriaMap, computeHashCode, doQueryToManyRelationship, getAliasedField, getField, getMapKeyDescriptor, getMapping, getMappingFromQueryKey, getName, getNestedAttributeName, getQueryKeyOrNull, getSelectionFields, index, isAttribute, isDirectCollection, isManyToMany, isMapKeyObjectRelationship, isOneToMany, isOneToOne, isQueryKeyExpression, normalize, rebuildOn, shouldQueryToManyRelationship, treat, valuesFromCollection

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

addDerivedExpression, anyOf, anyOfAllowingNone, clearAliases, copyDerivedExpressions, derivedExpressionNamed, derivedManualExpressionNamed, doNotUseOuterJoin, doUseOuterJoin, existingDerivedExpressionNamed, get, getAllowingNull, getCastClass, getFirstNonAggregateExpressionAfterExpressionBuilder, getJoinSource, getManualQueryKey, getOnClause, getOuterJoinExpIndex, hasBeenAliased, isDowncast, isObjectExpression, isTreatUsed, isUsingOuterJoinForMultitableInheritance, join, leftJoin, newDerivedExpressionNamed, newManualDerivedExpressionNamed, postCopyIn, setCastClass, setJoinSource, setOnClause, setOuterJoinExpIndex, setShouldUseOuterJoinForMultitableInheritance, shouldUseOuterJoin, shouldUseOuterJoinForMultitableInheritance, type

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

addDerivedField, addDerivedTable, asOf, copyCollection, existingDerivedField, existingDerivedTable, getAsOfClause, getContainingDescriptor, getField, getField, getTable, getTable, hasBeenNormalized, isDataExpression, iterateOn, newDerivedField, newDerivedTable, setHasBeenNormalized, setTableAliases, tableAliasesDescription

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

getBaseExpression, getBuilder, resetPlaceHolderBuilder, setBaseExpression, shallowClone

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

addDate, addDate, addMonths, addMonths, alias, all, 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, any, anyOf, anyOfAllowingNone, as, as, ascending, asciiValue, average, between, between, between, between, between, between, between, between, between, caseConditionStatement, caseConditionStatement, caseStatement, caseStatement, cast, clone, cloneUsing, coalesce, coalesce, concat, containsAllKeyWords, containsAnyKeyWords, containsSubstring, containsSubstring, containsSubstringIgnoringCase, containsSubstringIgnoringCase, 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, getAsOfClauseRecursively, getClonedField, getFunction, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getFunctionWithArguments, getNumberVal, getOperator, getOperator, getParameter, getParameter, getParameter, getProperty, getSelectionFields, getSession, getStringVal, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, hashCode, hexToRaw, ifNull, in, in, in, in, in, in, in, in, in, in, in, in, indexOf, intersect, intersect, intersectAll, intersectAll, isClassTypeExpression, isCompoundExpression, isConstantExpression, isEmpty, isExpressionBuilder, isFieldExpression, isFragment, isFunctionExpression, isLiteralExpression, isLogicalExpression, isMapEntryExpression, isNull, isParameterExpression, isRelationExpression, isSubSelectExpression, isTableExpression, isValueExpression, lastDay, 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, 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, ref, regexp, regexp, replace, replicate, replicate, reverse, right, right, rightPad, rightPad, rightTrim, rightTrim, roundDate, setLocalBase, setSelectIfOrderedBy, size, size, some, 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, trim, trim, truncateDate, twist, union, union, unionAll, unionAll, value, value, value, value, value, value, value, value, value, value, variance

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TreatAsExpression

public TreatAsExpression(java.lang.Class castClass,
                         ObjectExpression baseExpression)

Method Detail

convertToUseOuterJoin

public Expression convertToUseOuterJoin()

Description copied from class: Expression

INTERNAL: Modify this expression to use outer joins wherever there are equality operations between two field nodes.

Overrides:

convertToUseOuterJoin in class Expression

descriptionOfNodeType

public java.lang.String descriptionOfNodeType()

Description copied from class: QueryKeyExpression

INTERNAL: Used for debug printing.

Overrides:

descriptionOfNodeType in class QueryKeyExpression

equals

public boolean equals(java.lang.Object object)

Description copied from class: QueryKeyExpression

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 QueryKeyExpression

getFields

public java.util.Vector getFields()

Description copied from class: QueryKeyExpression

INTERNAL: Return all the fields

Overrides:

getFields in class QueryKeyExpression

getFieldValue

public java.lang.Object getFieldValue(java.lang.Object objectValue,
                                      AbstractSession session)

Description copied from class: QueryKeyExpression

INTERNAL: Transform the object-level value into a database-level value

Overrides:

getFieldValue in class QueryKeyExpression

getOwnedTables

public java.util.List<DatabaseTable> getOwnedTables()

This owns (can access) the child's extra tables as well as its parent's tables so we should pull these from super (which gets them from the current descriptor)

Overrides:

getOwnedTables in class QueryKeyExpression

getAlias

public Expression getAlias(Expression subSelect)

Description copied from class: DataExpression

ADVANCED: Return an expression representing a sub-select in the from clause.

Example:

  builder.getAlias(builder.subQuery(reportQuery)).get("type").equal("S");
 

Overrides:

getAlias in class DataExpression

getRelationTable

public DatabaseTable getRelationTable()

Calculate the relation table for based on the various QueryKeyExpression usages (join query keys, custom defined query keys, or query keys for mappings). Does not apply to Treat Called from SQLSelectStatement.appendFromClauseForOuterJoin(org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter, java.util.List<org.eclipse.persistence.internal.helper.DatabaseTable>, java.util.Collection, boolean).

Overrides:

getRelationTable in class QueryKeyExpression

Returns:

DatabaseTable

getTableAliases

public TableAliasLookup getTableAliases()

Description copied from class: DataExpression

INTERNAL: Return the aliases used. For CR#2456 must never lazily initialize as also used for Expression identity.

Overrides:

getTableAliases in class DataExpression

hasAsOfClause

public boolean hasAsOfClause()

Description copied from class: Expression

ADVANCED: Answers true if this is to be queried as of a past time.

Overrides:

hasAsOfClause in class DataExpression

Returns:

false from asOf(null); hasAsOfClause().

See Also:

Expression.getAsOfClause()

isDowncast

public boolean isDowncast()

INTERNAL:

isTreatExpression

public boolean isTreatExpression()

INTERNAL:

Overrides:

isTreatExpression in class Expression

printSQL

public void printSQL(ExpressionSQLPrinter printer)

Description copied from class: QueryKeyExpression

INTERNAL: Print SQL onto the stream, using the ExpressionPrinter for context

Overrides:

printSQL in class QueryKeyExpression

selectIfOrderedBy

public boolean selectIfOrderedBy()

Description copied from class: Expression

PUBLIC: Return whether this expression should be included in the SELECT clause if it is used in an ORDER BY clause

Overrides:

selectIfOrderedBy in class Expression

twistedForBaseAndContext

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

Description copied from class: QueryKeyExpression

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 QueryKeyExpression

validateNode

public void validateNode()

Description copied from class: QueryKeyExpression

Do any required validation for this node. Throw an exception if it's incorrect.

Overrides:

validateNode in class QueryKeyExpression

valueFromObject

public java.lang.Object valueFromObject(java.lang.Object object,
                                        AbstractSession session,
                                        AbstractRecord translationRow,
                                        int valueHolderPolicy,
                                        boolean isObjectUnregistered)

Description copied from class: QueryKeyExpression

INTERNAL: Return the value for in memory comparison. This is only valid for valueable expressions.

Overrides:

valueFromObject in class QueryKeyExpression

isObjectUnregistered - true if object possibly not a clone, but is being conformed against the unit of work cache.

valueFromObject

public java.lang.Object valueFromObject(java.lang.Object object,
                                        AbstractSession session,
                                        AbstractRecord translationRow,
                                        int valueHolderPolicy)

Description copied from class: Expression

INTERNAL: Return the value for in memory comparison. This is only valid for valueable expressions.

Overrides:

valueFromObject in class Expression

writeDescriptionOn

public void writeDescriptionOn(java.io.BufferedWriter writer)
                        throws java.io.IOException

Description copied from class: QueryKeyExpression

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

Overrides:

writeDescriptionOn in class QueryKeyExpression

Throws:

java.io.IOException

writeFields

public void writeFields(ExpressionSQLPrinter printer,
                        java.util.Vector newFields,
                        SQLSelectStatement statement)

Description copied from class: Expression

INTERNAL: called from SQLSelectStatement.writeFieldsFromExpression(...)

Overrides:

writeFields in class Expression

writeSubexpressionsTo

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

Description copied from class: DataExpression

Print the base for debuggin purposes.

Overrides:

writeSubexpressionsTo in class DataExpression

Throws:

java.io.IOException

getLeafDescriptor

public ClassDescriptor getLeafDescriptor(DatabaseQuery query,
                                         ClassDescriptor rootDescriptor,
                                         AbstractSession session)

Description copied from class: QueryKeyExpression

INTERNAL: Lookup the descriptor for this item by traversing its expression recursively.

Overrides:

getLeafDescriptor in class QueryKeyExpression

getLeafMapping

public DatabaseMapping getLeafMapping(DatabaseQuery query,
                                      ClassDescriptor rootDescriptor,
                                      AbstractSession session)

Description copied from class: QueryKeyExpression

INTERNAL: Lookup the mapping for this item by traversing its expression recursively. If an aggregate of foreign mapping is found it is traversed.

Overrides:

getLeafMapping in class QueryKeyExpression

aliasForTable

public DatabaseTable aliasForTable(DatabaseTable table)

Description copied from class: QueryKeyExpression

INTERNAL: Find the alias for a given table

Overrides:

aliasForTable in class QueryKeyExpression

rebuildOn

public Expression rebuildOn(Expression newBase)

INTERNAL: This expression is built on a different base than the one we want. Rebuild it and return the root of the new tree

Overrides:

rebuildOn in class QueryKeyExpression

See Also:

Expression.cloneUsing(Expression newBase)

getDescriptor

public ClassDescriptor getDescriptor()

Overrides:

getDescriptor in class ObjectExpression

convertToCastDescriptor

public ClassDescriptor convertToCastDescriptor(ClassDescriptor rootDescriptor,
                                               AbstractSession session)

INTERNAL - Return the descriptor which contains this query key, look in the inheritance hierarchy of rootDescriptor for the descriptor. Does not set the descriptor, only returns it.

Overrides:

convertToCastDescriptor in class ObjectExpression

getTypeClause

public Expression getTypeClause()

printJava

public void printJava(ExpressionJavaPrinter printer)

INTERNAL: Print java for project class generation

Overrides:

printJava in class QueryKeyExpression

assignTableAliasesStartingAt

public int assignTableAliasesStartingAt(int initialValue)

INTERNAL: Assign aliases to any tables which I own. Start with t(initialValue), and return the new value of the counter , i.e. if initialValue is one and I have tables ADDRESS and EMPLOYEE I will assign them t1 and t2 respectively, and return 3.

Overrides:

assignTableAliasesStartingAt in class ObjectExpression

getOwnedSubTables

public java.util.List<DatabaseTable> getOwnedSubTables()

INTERNAL: much like getOwnedTables(), this gets the tables represented from the descriptor. Difference is this only returns local tables for the child casted descriptor, and excludes tables owned by the parent descriptor

getAdditionalTables

public java.util.List<DatabaseTable> getAdditionalTables()

Description copied from class: QueryKeyExpression

INTERNAL: Return any additional tables that belong to this expression An example of how this method is used is to return any tables that belong to the map key when this expression traverses a mapping that uses a Map

Overrides:

getAdditionalTables in class QueryKeyExpression

mappingCriteria

public Expression mappingCriteria(Expression base)

Overrides:

mappingCriteria in class QueryKeyExpression

additionalTreatExpressionCriteriaMap

public java.util.Map additionalTreatExpressionCriteriaMap()

INTERNAL: Used in case outer joins should be printed in FROM clause. Each of the additional tables mapped to expressions that joins it.

getTreatCriteria

public Expression getTreatCriteria()

INTERNAL: this returns a single expression to represent the join from the main table to all child descriptor tables Only if outer joins should be printed in the where clause

Returns:

Expression

additionalTreatExpressionCriteria

public Expression additionalTreatExpressionCriteria()

INTERNAL: Return the expression to join the main table of this node to any auxiliary tables.

getSourceTable

public DatabaseTable getSourceTable()

Description copied from class: QueryKeyExpression

Calculate the source table for based on the various QueryKeyExpression usages (join query keys, custom defined query keys, or query keys for mappings). Called from SQLSelectStatement.appendFromClauseForOuterJoin(org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter, java.util.List<org.eclipse.persistence.internal.helper.DatabaseTable>, java.util.Collection, boolean).

Overrides:

getSourceTable in class QueryKeyExpression

Returns:

DatabaseTable

getReferenceTable

public DatabaseTable getReferenceTable()

Description copied from class: QueryKeyExpression

Calculate the reference table for based on the various QueryKeyExpression usages (join query keys, custom defined query keys, or query keys for mappings). Called from SQLSelectStatement.appendFromClauseForOuterJoin(org.eclipse.persistence.internal.expressions.ExpressionSQLPrinter, java.util.List<org.eclipse.persistence.internal.helper.DatabaseTable>, java.util.Collection, boolean).

Overrides:

getReferenceTable in class QueryKeyExpression

Returns:

DatabaseTable

normalize

public Expression normalize(ExpressionNormalizer normalizer,
                            Expression base,
                            java.util.List<Expression> foreignKeyJoinPointer)

Description copied from class: QueryKeyExpression

INTERNAL: For CR#2456 if this is part of an objExp.equal(objExp), do not need to add additional expressions to normalizer both times, and the foreign key join replaces the equal expression.

Overrides:

normalize in class QueryKeyExpression