oracle.toplink.essentials.internal.expressions

Class ObjectExpression

java.lang.Object

oracle.toplink.essentials.expressions.Expression

oracle.toplink.essentials.internal.expressions.DataExpression

oracle.toplink.essentials.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.Vector	derivedExpressions
ClassDescriptor	descriptor
protected boolean	shouldUseOuterJoin Is this query key to be resolved using an outer join or not.
protected boolean	shouldUseOuterJoinForMultitableInheritance indicates whether subclasses should be joined

Fields inherited from class oracle.toplink.essentials.internal.expressions.DataExpression

baseExpression, derivedFields, derivedTables, hasBeenNormalized, tableAliases

Fields inherited from class oracle.toplink.essentials.expressions.Expression

currentAlias, lastTable, selectIfOrderedBy

Constructor Summary

Constructors

Constructor and Description
ObjectExpression()

Method Summary

Modifier and Type	Method and Description
void	addDerivedExpression(Expression addThis)
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) PUBLIC: Return an expression representing traversal of a 1:many or many:many relationship.
QueryKeyExpression	derivedExpressionNamed(java.lang.String attributeName)
Expression	derivedManualExpressionNamed(java.lang.String attributeName, ClassDescriptor aDescriptor)
protected void	doNotUseOuterJoin()
protected void	doUseOuterJoin()
QueryKeyExpression	existingDerivedExpressionNamed(java.lang.String attributeName)
Expression	get(java.lang.String attributeName, java.util.Vector arguments) INTERNAL:
Expression	getAllowingNull(java.lang.String attributeName, java.util.Vector arguments) INTERNAL:
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.
protected java.util.Vector	getForUpdateOfFields() INTERNAL: Returns the first field from each of the owned tables, used for fine-grained pessimistic locking.
Expression	getManualQueryKey(java.lang.String attributeName, ClassDescriptor aDescriptor)
java.util.Vector	getOwnedTables() INTERNAL:
protected boolean	hasDerivedExpressions()
boolean	isObjectExpression() INTERNAL:
boolean	isUsingOuterJoinForMultitableInheritance() INTERNAL: indicates whether additional expressions for multitable inheritance should be used and are available
QueryKeyExpression	newDerivedExpressionNamed(java.lang.String attributeName)
Expression	newManualDerivedExpressionNamed(java.lang.String attributeName, ClassDescriptor aDescriptor)
protected void	postCopyIn(java.util.Dictionary alreadyDone) INTERNAL: Used for cloning.
void	postCopyIn(java.util.Dictionary alreadyDone, java.util.Vector oldDerivedFields, java.util.Vector oldDerivedTables) INTERNAL: The method was added to circumvent derivedFields and derivedTables being protected.
void	setShouldUseOuterJoinForMultitableInheritance(boolean shouldUseOuterJoinForMultitableInheritance) INTERNAL: set the flag indicating whether subclasses should be joined
boolean	shouldUseOuterJoin()
boolean	shouldUseOuterJoinForMultitableInheritance()
protected void	writeForUpdateOfFields(ExpressionSQLPrinter printer, SQLSelectStatement statement) INTERNAL: writes the first field from each of the owned tables, used for fine-grained pessimistic locking.

Methods inherited from class oracle.toplink.essentials.internal.expressions.DataExpression

addDerivedField, addDerivedTable, aliasForTable, assignAlias, assignAlias, clearAliases, copyCollection, existingDerivedField, existingDerivedTable, getAliasedField, getBaseExpression, getBuilder, getField, getField, getField, getMapping, getQueryKeyOrNull, getTable, getTable, getTableAliases, hasBeenAliased, hasBeenNormalized, hasDerivedFields, hasDerivedTables, isAttribute, isDataExpression, iterateOn, mappingCriteria, newDerivedField, newDerivedTable, normalize, printSQL, setBaseExpression, setHasBeenNormalized, setTableAliases, tableAliasesDescription, writeSubexpressionsTo

Methods inherited from class oracle.toplink.essentials.expressions.Expression

addDate, addDate, addMonths, addMonths, 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, anyOfAllowingNone, ascending, asciiValue, assignTableAliasesStartingAt, average, between, between, between, between, between, between, between, between, between, caseStatement, clone, cloneUsing, 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, descriptionOfNodeType, detectExpression, difference, distinct, doesConform, doesConform, equal, equal, equal, equal, equal, equal, equal, equal, equal, equal, equalOuterJoin, equalOuterJoin, equalsIgnoreCase, equalsIgnoreCase, exists, existsNode, extract, extractPrimaryKeyValues, extractValue, from, fromConstant, fromLiteral, get, getAllowingNull, getClonedField, getFieldValue, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getName, getNumberVal, getOperator, getOperator, getParameter, getParameter, getParameter, getSession, getStringVal, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, hasAsOfClause, hexToRaw, ifNull, in, in, in, in, in, in, in, in, in, in, in, in, indexOf, isCompoundExpression, isConstantExpression, isEmpty, isExpressionBuilder, isFieldExpression, isFragment, isFunctionExpression, isLiteralExpression, isLogicalExpression, isNull, isParameterExpression, isQueryKeyExpression, isRelationExpression, 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, 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, notNull, or, performOperator, postfixSQL, prefixSQL, printJava, printSQLWithoutConversion, rebuildOn, ref, registerIn, replace, replicate, replicate, resetCache, reverse, right, right, rightPad, rightPad, rightTrim, rightTrim, roundDate, selectIfOrderedBy, setLocalBase, setSelectIfOrderedBy, shallowClone, size, some, some, some, some, some, some, some, some, some, some, some, some, standardDeviation, subQuery, substring, substring, sum, toChar, toChar, toCharacter, toDate, toLowerCase, toNumber, toString, toString, toUpperCase, toUppercaseCasedWords, translate, trim, trim, truncateDate, twist, twistedForBaseAndContext, validateNode, value, value, value, value, value, value, value, value, value, value, valueFromObject, valueFromObject, variance, writeDescriptionOn, writeField, writeFields

Methods inherited from class java.lang.Object

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

Field Detail

descriptor

public transient ClassDescriptor descriptor

derivedExpressions

public java.util.Vector derivedExpressions

shouldUseOuterJoinForMultitableInheritance

protected boolean shouldUseOuterJoinForMultitableInheritance

indicates whether subclasses should be joined

shouldUseOuterJoin

protected boolean shouldUseOuterJoin

Is this query key to be resolved using an outer join or not. Does not apply to attributes.

Constructor Detail

ObjectExpression

public ObjectExpression()

Method Detail

addDerivedExpression

public void addDerivedExpression(Expression addThis)

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)

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:

     TopLink: 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

derivedExpressionNamed

public QueryKeyExpression derivedExpressionNamed(java.lang.String attributeName)

derivedManualExpressionNamed

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

doNotUseOuterJoin

protected void doNotUseOuterJoin()

doUseOuterJoin

protected void doUseOuterJoin()

existingDerivedExpressionNamed

public QueryKeyExpression existingDerivedExpressionNamed(java.lang.String attributeName)

get

public Expression get(java.lang.String attributeName,
                      java.util.Vector arguments)

Description copied from class: Expression

INTERNAL:

Overrides:

get in class Expression

getAllowingNull

public Expression getAllowingNull(java.lang.String attributeName,
                                  java.util.Vector arguments)

Description copied from class: Expression

INTERNAL:

Overrides:

getAllowingNull 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

getForUpdateOfFields

protected java.util.Vector getForUpdateOfFields()

INTERNAL: Returns the first field from each of the owned tables, used for fine-grained pessimistic locking.

getManualQueryKey

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

getOwnedTables

public java.util.Vector getOwnedTables()

INTERNAL:

Overrides:

getOwnedTables in class DataExpression

hasDerivedExpressions

protected boolean hasDerivedExpressions()

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)

postCopyIn

protected void postCopyIn(java.util.Dictionary alreadyDone)

INTERNAL: Used for cloning.

Overrides:

postCopyIn in class DataExpression

postCopyIn

public void postCopyIn(java.util.Dictionary alreadyDone,
                       java.util.Vector oldDerivedFields,
                       java.util.Vector oldDerivedTables)

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

See Also:

ExpressionBuilder.registerIn(Dictionary alreadyDone)

setShouldUseOuterJoinForMultitableInheritance

public void setShouldUseOuterJoinForMultitableInheritance(boolean shouldUseOuterJoinForMultitableInheritance)

INTERNAL: set the flag indicating whether subclasses should be joined

shouldUseOuterJoin

public boolean shouldUseOuterJoin()

shouldUseOuterJoinForMultitableInheritance

public boolean shouldUseOuterJoinForMultitableInheritance()

writeForUpdateOfFields

protected void writeForUpdateOfFields(ExpressionSQLPrinter printer,
                                      SQLSelectStatement statement)

INTERNAL: writes the first field from each of the owned tables, used for fine-grained pessimistic locking.