oracle.toplink.essentials.internal.expressions

Class QueryKeyExpression

java.lang.Object

oracle.toplink.essentials.expressions.Expression

oracle.toplink.essentials.internal.expressions.DataExpression

oracle.toplink.essentials.internal.expressions.ObjectExpression

oracle.toplink.essentials.internal.expressions.QueryKeyExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ManualQueryKeyExpression

public class QueryKeyExpression
extends ObjectExpression

Represents expression on query keys or mappings. This includes direct, relationships query keys and mappings.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseField	aliasedField Cache the aliased field.
protected boolean	hasMapping
protected boolean	hasQueryKey
protected DatabaseMapping	mapping Same for mappings.
protected java.lang.String	name The name of the query key.
protected QueryKey	queryKey Cache the query key for performance.
protected boolean	shouldQueryToManyRelationship Is this a query across a 1:many or many:many relationship.

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

derivedExpressions, descriptor, shouldUseOuterJoin, shouldUseOuterJoinForMultitableInheritance

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
QueryKeyExpression()
QueryKeyExpression(java.lang.String aName, Expression base)

Method Summary

Modifier and Type	Method and Description
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.
DatabaseTable	aliasForTable(DatabaseTable table) INTERNAL: Find the alias for a given table
java.lang.String	descriptionOfNodeType() INTERNAL: Used for debug printing.
void	doQueryToManyRelationship() INTERNAL:
DatabaseField	getAliasedField() INTERNAL: Return the field appropriately aliased
protected DatabaseTable	getAliasedTable() Return the alias for our table
ClassDescriptor	getContainingDescriptor() INTERNAL: Return the descriptor which contains this query key.
DatabaseField	getField() INTERNAL:
java.util.Vector	getFields() INTERNAL: Return all the fields
java.lang.Object	getFieldValue(java.lang.Object objectValue) INTERNAL: Transform the object-level value into a database-level value
DatabaseMapping	getMapping()
DatabaseMapping	getMappingFromQueryKey()
java.lang.String	getName() INTERNAL:
java.util.Vector	getOwnedTables() INTERNAL:
QueryKey	getQueryKeyOrNull()
protected void	initializeAliasedField() INTERNAL: Alias the database field for our current environment
boolean	isAttribute() INTERNAL:
boolean	isNormalizationRequired() INTERNAL: Indicates that RelationExpression.normalize method shouldn't attempt optimize normalization by not normalizing this.
boolean	isQueryKeyExpression() INTERNAL:
Expression	mappingCriteria()
Expression	normalize(ExpressionNormalizer normalizer) INTERNAL: Normalize the expression into a printable structure.
Expression	normalize(ExpressionNormalizer normalizer, java.util.Vector 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.
Expression	rebuildOn(Expression oldBase, Expression newBase) INTERNAL: A special version of rebuildOn where the newBase need not be a new ExpressionBuilder but any expression.
protected void	resetCache() Reset cached information here so that we can be sure we're accurate.
boolean	shouldQueryToManyRelationship()
Expression	twistedForBaseAndContext(Expression newBase, Expression context) 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, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean isObjectUnregistered) INTERNAL: Return the value for in memory comparison.
java.lang.Object	valuesFromCollection(java.lang.Object object, AbstractSession session, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean isObjectUnregistered) INTERNAL This method iterates through a collection and gets the values from the objects to conform in an in-memory query.
void	writeDescriptionOn(java.io.BufferedWriter writer) INTERNAL: Used to print a debug form of the expression tree.

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

addDerivedExpression, anyOf, derivedExpressionNamed, derivedManualExpressionNamed, doNotUseOuterJoin, doUseOuterJoin, existingDerivedExpressionNamed, get, getAllowingNull, getDescriptor, getForUpdateOfFields, getManualQueryKey, hasDerivedExpressions, isObjectExpression, isUsingOuterJoinForMultitableInheritance, newDerivedExpressionNamed, newManualDerivedExpressionNamed, postCopyIn, postCopyIn, setShouldUseOuterJoinForMultitableInheritance, shouldUseOuterJoin, shouldUseOuterJoinForMultitableInheritance, writeForUpdateOfFields

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

addDerivedField, addDerivedTable, assignAlias, assignAlias, clearAliases, copyCollection, existingDerivedField, existingDerivedTable, getBaseExpression, getBuilder, getField, getField, getTable, getTable, getTableAliases, hasBeenAliased, hasBeenNormalized, hasDerivedFields, hasDerivedTables, isDataExpression, iterateOn, newDerivedField, newDerivedTable, 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, 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, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, 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, 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, printSQLWithoutConversion, ref, registerIn, replace, replicate, replicate, 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, value, value, value, value, value, value, value, value, value, value, valueFromObject, variance, writeField, writeFields

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The name of the query key.

aliasedField

protected DatabaseField aliasedField

Cache the aliased field. Only applies to attributes.

shouldQueryToManyRelationship

protected boolean shouldQueryToManyRelationship

Is this a query across a 1:many or many:many relationship. Does not apply to attributes.

queryKey

protected transient QueryKey queryKey

Cache the query key for performance. Store a boolean so we don't repeat the search if there isn't one.

hasQueryKey

protected boolean hasQueryKey

mapping

protected transient DatabaseMapping mapping

Same for mappings.

hasMapping

protected boolean hasMapping

Constructor Detail

QueryKeyExpression

public QueryKeyExpression()

QueryKeyExpression

public QueryKeyExpression(java.lang.String aName,
                          Expression base)

Method Detail

additionalExpressionCriteria

public Expression additionalExpressionCriteria()

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

Overrides:

additionalExpressionCriteria in class ObjectExpression

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.

Overrides:

additionalExpressionCriteriaMap in class ObjectExpression

aliasForTable

public DatabaseTable aliasForTable(DatabaseTable table)

INTERNAL: Find the alias for a given table

Overrides:

aliasForTable in class DataExpression

descriptionOfNodeType

public java.lang.String descriptionOfNodeType()

INTERNAL: Used for debug printing.

Overrides:

descriptionOfNodeType in class Expression

doQueryToManyRelationship

public void doQueryToManyRelationship()

INTERNAL:

getAliasedField

public DatabaseField getAliasedField()

INTERNAL: Return the field appropriately aliased

Overrides:

getAliasedField in class DataExpression

getAliasedTable

protected DatabaseTable getAliasedTable()

Return the alias for our table

getContainingDescriptor

public ClassDescriptor getContainingDescriptor()

INTERNAL: Return the descriptor which contains this query key.

getField

public DatabaseField getField()

INTERNAL:

Overrides:

getField in class DataExpression

getFields

public java.util.Vector getFields()

INTERNAL: Return all the fields

Overrides:

getFields in class ObjectExpression

getFieldValue

public java.lang.Object getFieldValue(java.lang.Object objectValue)

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

Overrides:

getFieldValue in class Expression

getMapping

public DatabaseMapping getMapping()

Overrides:

getMapping in class DataExpression

getMappingFromQueryKey

public DatabaseMapping getMappingFromQueryKey()

getName

public java.lang.String getName()

Description copied from class: Expression

INTERNAL:

Overrides:

getName in class Expression

getOwnedTables

public java.util.Vector getOwnedTables()

INTERNAL:

Overrides:

getOwnedTables in class ObjectExpression

getQueryKeyOrNull

public QueryKey getQueryKeyOrNull()

Overrides:

getQueryKeyOrNull in class DataExpression

initializeAliasedField

protected void initializeAliasedField()

INTERNAL: Alias the database field for our current environment

isAttribute

public boolean isAttribute()

INTERNAL:

Overrides:

isAttribute in class DataExpression

isQueryKeyExpression

public boolean isQueryKeyExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isQueryKeyExpression in class Expression

mappingCriteria

public Expression mappingCriteria()

Overrides:

mappingCriteria in class DataExpression

normalize

public Expression normalize(ExpressionNormalizer normalizer)

INTERNAL: Normalize the expression into a printable structure. Any joins must be added to form a new root.

Overrides:

normalize in class DataExpression

normalize

public Expression normalize(ExpressionNormalizer normalizer,
                            java.util.Vector 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.

printSQL

public void printSQL(ExpressionSQLPrinter printer)

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

Overrides:

printSQL in class DataExpression

printJava

public void printJava(ExpressionJavaPrinter printer)

INTERNAL: Print java for project class generation

Overrides:

printJava in class Expression

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

Specified by:

rebuildOn in class Expression

See Also:

Expression.cloneUsing(Expression newBase)

rebuildOn

public Expression rebuildOn(Expression oldBase,
                            Expression newBase)

INTERNAL: A special version of rebuildOn where the newBase need not be a new ExpressionBuilder but any expression.

For nested joined attributes, the joined attribute query must have its joined attributes rebuilt relative to it.

resetCache

protected void resetCache()

Reset cached information here so that we can be sure we're accurate.

Overrides:

resetCache in class Expression

shouldQueryToManyRelationship

public boolean shouldQueryToManyRelationship()

twistedForBaseAndContext

public Expression twistedForBaseAndContext(Expression newBase,
                                           Expression context)

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

validateNode

public void validateNode()

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

Overrides:

validateNode in class Expression

valueFromObject

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

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

Overrides:

valueFromObject in class Expression

valuesFromCollection

public java.lang.Object valuesFromCollection(java.lang.Object object,
                                             AbstractSession session,
                                             InMemoryQueryIndirectionPolicy valueHolderPolicy,
                                             boolean isObjectUnregistered)

INTERNAL This method iterates through a collection and gets the values from the objects to conform in an in-memory query. Creation date: (1/19/01 1:18:27 PM)

writeDescriptionOn

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

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

Overrides:

writeDescriptionOn in class Expression

Throws:

java.io.IOException

isNormalizationRequired

public boolean isNormalizationRequired()

INTERNAL: Indicates that RelationExpression.normalize method shouldn't attempt optimize normalization by not normalizing this.