org.eclipse.persistence.internal.expressions

Class ObjectExpression

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ExpressionBuilder, QueryKeyExpression

public abstract class ObjectExpression
extends DataExpression

Superclass for any object type expressions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Expression>	derivedExpressions

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

shouldUseUpperCaseForIgnoreCase

Constructor Summary

Constructors

Constructor and Description
ObjectExpression()

Method Summary

Modifier and Type	Method and Description
void	addDerivedExpression(Expression addThis) INTERNAL: Add the expression as a derived child of this expression.
Expression	additionalExpressionCriteria() INTERNAL: Return the expression to join the main table of this node to any auxiliary tables.
java.util.Map	additionalExpressionCriteriaMap() INTERNAL: Used in case outer joins should be printed in FROM clause.
Expression	anyOf(java.lang.String attributeName, boolean shouldJoinBeIndependent) PUBLIC: Return an expression representing traversal of a 1:many or many:many relationship.
Expression	anyOfAllowingNone(java.lang.String attributeName, boolean shouldJoinBeIndependent) ADVANCED: Return an expression representing traversal of a 1:many or many:many relationship.
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.
java.util.List<Expression>	copyDerivedExpressions(java.util.Map alreadyDone)
QueryKeyExpression	derivedExpressionNamed(java.lang.String attributeName)
Expression	derivedManualExpressionNamed(java.lang.String attributeName, ClassDescriptor aDescriptor)
void	doNotUseOuterJoin()
void	doUseOuterJoin()
boolean	equals(java.lang.Object expression) INTERNAL: Return if the expression is equal to the other.
QueryKeyExpression	existingDerivedExpressionNamed(java.lang.String attributeName)
Expression	get(java.lang.String attributeName) Return the expression from the attribute dervied from this expression.
java.util.List<DatabaseTable>	getAdditionalTables() Return any tables in addition to the descriptor's tables, such as the mappings join table.
Expression	getAllowingNull(java.lang.String attributeName) ADVANCED: Return an expression that wraps the attribute or query key name.
java.lang.Class	getCastClass()
ClassDescriptor	getDescriptor()
java.util.Vector	getFields() INTERNAL: Not to be confused with the public getField(String) This returns a collection of all fields associated with this object.
Expression	getJoinSource()
Expression	getManualQueryKey(java.lang.String attributeName, ClassDescriptor aDescriptor)
Expression	getOnClause()
java.util.Vector	getOwnedTables() Return any tables that are defined by this expression (and not its base).
DatabaseTable	getRelationTable() Return null by default, only QueryKeyExpression can have a relation table.
boolean	isDirectCollection() Return false by default, only possible for QueryKeyExpression.
boolean	isDowncast(ClassDescriptor rootDescriptor, AbstractSession session) INTERNAL Return true if it uses a cast class and query is downcasting.
boolean	isObjectExpression() INTERNAL:
boolean	isUsingOuterJoinForMultitableInheritance() INTERNAL: indicates whether additional expressions for multitable inheritance should be used and are available
Expression	join(Expression target, Expression onClause) Defines a join between this expression and the target expression based on the ON clause.
Expression	leftJoin(Expression target, Expression onClause) Defines a join between this expression and the target expression based on the ON clause.
QueryKeyExpression	newDerivedExpressionNamed(java.lang.String attributeName)
Expression	newManualDerivedExpressionNamed(java.lang.String attributeName, ClassDescriptor aDescriptor)
void	postCopyIn(java.util.Map alreadyDone, java.util.List<Expression> oldDerivedFields, java.util.List<Expression> oldDerivedTables) INTERNAL: The method was added to circumvent derivedFields and derivedTables being protected.
void	setCastClass(java.lang.Class castClass)
void	setJoinSource(Expression joinSource)
void	setOnClause(Expression onClause)
void	setShouldUseOuterJoinForMultitableInheritance(boolean shouldUseOuterJoinForMultitableInheritance) INTERNAL: set the flag indicating whether subclasses should be joined
boolean	shouldUseOuterJoin()
boolean	shouldUseOuterJoinForMultitableInheritance()
Expression	treat(java.lang.Class castClass) ADVANCED: Return an expression that allows you to treat its base as if it were a subclass of the class returned by the base This can only be called on an ExpressionBuilder, the result of expression.get(String), expression.getAllowingNull(String), the result of expression.anyOf("String") or the result of expression.anyOfAllowingNull("String") downcast does not guarantee the results of the downcast will be of the specified class and should be used in conjunction with a Expression.type()
Expression	type() PUBLIC: Return an expression that wraps the inheritance type field in an expression.

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

addDerivedField, addDerivedTable, aliasForTable, asOf, clearAliases, copyCollection, existingDerivedField, existingDerivedTable, getAlias, getAliasedField, getAsOfClause, getContainingDescriptor, getField, getField, getField, getMapping, getQueryKeyOrNull, getTable, getTable, getTableAliases, hasAsOfClause, hasBeenAliased, hasBeenNormalized, isAttribute, isDataExpression, iterateOn, newDerivedField, newDerivedTable, normalize, printSQL, setHasBeenNormalized, setTableAliases, tableAliasesDescription, writeSubexpressionsTo

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, 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, convertToUseOuterJoin, copiedVersionFrom, count, create, create, createWithBaseLast, currentDate, currentDateDate, currentTime, currentTimeStamp, dateDifference, dateDifference, dateName, datePart, dateToString, decode, descending, descriptionOfNodeType, 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, getAsOfClauseRecursively, getClonedField, getFieldValue, getFunction, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getFunctionWithArguments, getLeafDescriptor, getLeafMapping, getName, getNumberVal, getOperator, getOperator, getParameter, getParameter, getParameter, getProperty, 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, index, indexOf, intersect, intersect, intersectAll, intersectAll, isClassTypeExpression, isCompoundExpression, isConstantExpression, isEmpty, isExpressionBuilder, isFieldExpression, isFragment, isFunctionExpression, isLiteralExpression, isLogicalExpression, isMapEntryExpression, isNull, isParameterExpression, isQueryKeyExpression, 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, printJava, rebuildOn, ref, regexp, regexp, replace, replicate, replicate, 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, some, sql, standardDeviation, subQuery, substring, substring, substring, substring, sum, toChar, toChar, toCharacter, toDate, toLowerCase, toNumber, toString, toString, toUpperCase, toUppercaseCasedWords, translate, trim, trim, truncateDate, twist, twistedForBaseAndContext, union, union, unionAll, unionAll, validateNode, value, value, value, value, value, value, value, value, value, value, valueFromObject, valueFromObject, variance, writeDescriptionOn, writeFields

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

derivedExpressions

public java.util.List<Expression> derivedExpressions

Constructor Detail

ObjectExpression

public ObjectExpression()

Method Detail

treat

public Expression treat(java.lang.Class castClass)

ADVANCED: Return an expression that allows you to treat its base as if it were a subclass of the class returned by the base This can only be called on an ExpressionBuilder, the result of expression.get(String), expression.getAllowingNull(String), the result of expression.anyOf("String") or the result of expression.anyOfAllowingNull("String") downcast does not guarantee the results of the downcast will be of the specified class and should be used in conjunction with a Expression.type()

Example:

     Expression: employee.get("project").as(LargeProject.class).get("budget").equal(1000)
     Java: ((LargeProject)employee.getProjects().get(0)).getBudget() == 1000
     SQL: LPROJ.PROJ_ID (+)= PROJ.PROJ_ID AND L_PROJ.BUDGET = 1000
 

Overrides:

treat in class Expression

equals

public boolean equals(java.lang.Object expression)

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 DataExpression

addDerivedExpression

public void addDerivedExpression(Expression addThis)

INTERNAL: Add the expression as a derived child of this expression. i.e. e.get("name"), "name" is a derived child of "e".

additionalExpressionCriteria

public Expression additionalExpressionCriteria()

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

additionalExpressionCriteriaMap

public java.util.Map additionalExpressionCriteriaMap()

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

anyOf

public Expression anyOf(java.lang.String attributeName,
                        boolean shouldJoinBeIndependent)

PUBLIC: Return an expression representing traversal of a 1:many or many:many relationship. This allows you to query whether any of the "many" side of the relationship satisfies the remaining criteria.

Example:

     Expression: employee.anyOf("managedEmployees").get("firstName").equal("Bob")
     Java: no direct equivalent
     SQL: SELECT DISTINCT ... WHERE (t2.MGR_ID = t1.ID) AND (t2.F_NAME = 'Bob')
 

Overrides:

anyOf in class Expression

anyOfAllowingNone

public Expression anyOfAllowingNone(java.lang.String attributeName,
                                    boolean shouldJoinBeIndependent)

ADVANCED: Return an expression representing traversal of a 1:many or many:many relationship. This allows you to query whether any of the "many" side of the relationship satisfies the remaining criteria.

Example:

     Expression: employee.anyOf("managedEmployees").get("firstName").equal("Bob")
     Java: no direct equivalent
     SQL: SELECT DISTINCT ... WHERE (t2.MGR_ID (+) = t1.ID) AND (t2.F_NAME = 'Bob')
 

Overrides:

anyOfAllowingNone in class Expression

isDowncast

public boolean isDowncast(ClassDescriptor rootDescriptor,
                          AbstractSession session)

INTERNAL Return true if it uses a cast class and query is downcasting. It will look into inheritance hierarchy of the root descriptor.

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.

copyDerivedExpressions

public java.util.List<Expression> copyDerivedExpressions(java.util.Map alreadyDone)

derivedExpressionNamed

public QueryKeyExpression derivedExpressionNamed(java.lang.String attributeName)

derivedManualExpressionNamed

public Expression derivedManualExpressionNamed(java.lang.String attributeName,
                                               ClassDescriptor aDescriptor)

doNotUseOuterJoin

public void doNotUseOuterJoin()

doUseOuterJoin

public void doUseOuterJoin()

existingDerivedExpressionNamed

public QueryKeyExpression existingDerivedExpressionNamed(java.lang.String attributeName)

get

public Expression get(java.lang.String attributeName)

Return the expression from the attribute dervied from this expression.

Overrides:

get in class Expression

leftJoin

public Expression leftJoin(Expression target,
                           Expression onClause)

Defines a join between this expression and the target expression based on the ON clause.

Overrides:

leftJoin in class Expression

join

public Expression join(Expression target,
                       Expression onClause)

Defines a join between this expression and the target expression based on the ON clause.

Overrides:

join in class Expression

getAllowingNull

public Expression getAllowingNull(java.lang.String attributeName)

Description copied from class: Expression

ADVANCED: Return an expression that wraps the attribute or query key name. This is only applicable to 1:1 relationships, and allows the target of the relationship to be null if there is no corresponding relationship in the database. Implemented via an outer join in the database.

Example:

  builder.getAllowingNull("address").get("city").equal("Ottawa");
 

Overrides:

getAllowingNull in class Expression

getCastClass

public java.lang.Class getCastClass()

type

public Expression type()

PUBLIC: Return an expression that wraps the inheritance type field in an expression.

Example:

  builder.getClassForInheritance().equal(SmallProject.class);
 

Overrides:

type in class Expression

getDescriptor

public ClassDescriptor getDescriptor()

Overrides:

getDescriptor in class DataExpression

getFields

public java.util.Vector getFields()

INTERNAL: Not to be confused with the public getField(String) This returns a collection of all fields associated with this object. Really only applies to query keys representing an object or to expression builders.

Overrides:

getFields in class Expression

getManualQueryKey

public Expression getManualQueryKey(java.lang.String attributeName,
                                    ClassDescriptor aDescriptor)

getAdditionalTables

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

Return any tables in addition to the descriptor's tables, such as the mappings join table.

getOwnedTables

public java.util.Vector getOwnedTables()

Return any tables that are defined by this expression (and not its base).

Overrides:

getOwnedTables in class Expression

isObjectExpression

public boolean isObjectExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isObjectExpression in class Expression

isUsingOuterJoinForMultitableInheritance

public boolean isUsingOuterJoinForMultitableInheritance()

INTERNAL: indicates whether additional expressions for multitable inheritance should be used and are available

newDerivedExpressionNamed

public QueryKeyExpression newDerivedExpressionNamed(java.lang.String attributeName)

newManualDerivedExpressionNamed

public Expression newManualDerivedExpressionNamed(java.lang.String attributeName,
                                                  ClassDescriptor aDescriptor)

getRelationTable

public DatabaseTable getRelationTable()

Return null by default, only QueryKeyExpression can have a relation table.

isDirectCollection

public boolean isDirectCollection()

Return false by default, only possible for QueryKeyExpression.

postCopyIn

public void postCopyIn(java.util.Map alreadyDone,
                       java.util.List<Expression> oldDerivedFields,
                       java.util.List<Expression> oldDerivedTables)

INTERNAL: The method was added to circumvent derivedFields and derivedTables being protected.

See Also:

ExpressionBuilder.registerIn(Map alreadyDone)

getOnClause

public Expression getOnClause()

setOnClause

public void setOnClause(Expression onClause)

setCastClass

public void setCastClass(java.lang.Class castClass)

setShouldUseOuterJoinForMultitableInheritance

public void setShouldUseOuterJoinForMultitableInheritance(boolean shouldUseOuterJoinForMultitableInheritance)

INTERNAL: set the flag indicating whether subclasses should be joined

shouldUseOuterJoin

public boolean shouldUseOuterJoin()

shouldUseOuterJoinForMultitableInheritance

public boolean shouldUseOuterJoinForMultitableInheritance()

getJoinSource

public Expression getJoinSource()

setJoinSource

public void setJoinSource(Expression joinSource)