oracle.toplink.essentials.internal.expressions

Class ParameterExpression

java.lang.Object

oracle.toplink.essentials.expressions.Expression

oracle.toplink.essentials.internal.expressions.ParameterExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ParameterExpression
extends Expression

Used for parameterized expressions, such as expression defined in mapping queries.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Expression	baseExpression The base expression is what the parameter was derived from, used for nested parameters.
protected DatabaseField	field The parameter field or name.
protected Expression	localBase The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

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

currentAlias, lastTable, selectIfOrderedBy

Constructor Summary

Constructors

Constructor and Description
ParameterExpression()
ParameterExpression(DatabaseField field)
ParameterExpression(DatabaseField field, Expression baseExpression)
ParameterExpression(java.lang.String fieldName)
ParameterExpression(java.lang.String fieldName, Expression baseExpression, java.lang.Object type)

Method Summary

Modifier and Type	Method and Description
java.lang.String	basicDescription() Return description.
java.lang.String	descriptionOfNodeType() INTERNAL: Used for debug printing.
Expression	get(java.lang.String attributeOrQueryKey) This allows for nesting of parametrized expression.
Expression	getBaseExpression() The base expression is what the parameter was derived from.
ExpressionBuilder	getBuilder() Return the expression builder which is the ultimate base of this expression, or null if there isn't one (shouldn't happen if we start from a root)
DatabaseField	getField()
Expression	getField(DatabaseField field) This allows for nesting of parametrized expression.
Expression	getLocalBase() The opposite side of the relation, this is used for conversion of the parameter using the others mapping.
java.lang.Object	getType() The infered type of this parameter.
java.lang.Object	getValue(AbstractRecord translationRow, AbstractSession session) Extract the value from the row.
boolean	isParameterExpression() INTERNAL:
boolean	isValueExpression() INTERNAL:
protected void	postCopyIn(java.util.Dictionary alreadyDone) INTERNAL: Used for cloning.
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.
protected void	setBaseExpression(Expression baseExpression) The base expression is what the parameter was derived from.
void	setLocalBase(Expression localBase) The opposite side of the relation, this is used for conversion of the parameter using the others mapping.
Expression	twistedForBaseAndContext(Expression newBase, Expression context) INTERNAL: Rebuild against the base, with the values of parameters supplied by the context expression.
java.lang.Object	valueFromObject(java.lang.Object object, AbstractSession session, AbstractRecord translationRow, InMemoryQueryIndirectionPolicy 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: Append the parameter into the printer.
void	writeSubexpressionsTo(java.io.BufferedWriter writer, int indent) Print the base for debuggin purposes.

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

addDate, addDate, addMonths, addMonths, 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, anyOfAllowingNone, ascending, asciiValue, assignAlias, 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, getAllowingNull, getClonedField, getField, getFields, getFieldValue, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getName, getNumberVal, getOperator, getOperator, getOwnedTables, getParameter, getParameter, getParameter, 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, hexToRaw, ifNull, in, in, in, in, in, in, in, in, in, in, in, in, indexOf, isCompoundExpression, isConstantExpression, isDataExpression, isEmpty, isExpressionBuilder, isFieldExpression, isFragment, isFunctionExpression, isLiteralExpression, isLogicalExpression, isNull, isObjectExpression, isQueryKeyExpression, isRelationExpression, isTableExpression, iterateOn, 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, normalize, 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, resetCache, reverse, right, right, rightPad, rightPad, rightTrim, rightTrim, roundDate, selectIfOrderedBy, 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, validateNode, value, value, value, value, value, value, value, value, value, value, valueFromObject, variance, writeField

Methods inherited from class java.lang.Object

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

Field Detail

field

protected DatabaseField field

The parameter field or name.

localBase

protected Expression localBase

The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

baseExpression

protected Expression baseExpression

The base expression is what the parameter was derived from, used for nested parameters.

Constructor Detail

ParameterExpression

public ParameterExpression()

ParameterExpression

public ParameterExpression(java.lang.String fieldName)

ParameterExpression

public ParameterExpression(DatabaseField field)

ParameterExpression

public ParameterExpression(java.lang.String fieldName,
                           Expression baseExpression,
                           java.lang.Object type)

ParameterExpression

public ParameterExpression(DatabaseField field,
                           Expression baseExpression)

Method Detail

basicDescription

public java.lang.String basicDescription()

Return description. Used for toString.

descriptionOfNodeType

public java.lang.String descriptionOfNodeType()

INTERNAL: Used for debug printing.

Overrides:

descriptionOfNodeType in class Expression

get

public Expression get(java.lang.String attributeOrQueryKey)

This allows for nesting of parametrized expression. This is used for parameterizing object comparisons.

Overrides:

get in class Expression

getBaseExpression

public Expression getBaseExpression()

The base expression is what the parameter was derived from. This is used for nested parameters.

getBuilder

public ExpressionBuilder getBuilder()

Return the expression builder which is the ultimate base of this expression, or null if there isn't one (shouldn't happen if we start from a root)

Specified by:

getBuilder in class Expression

getField

public DatabaseField getField()

getField

public Expression getField(DatabaseField field)

This allows for nesting of parametrized expression. This is used for parameterizing object comparisons.

Overrides:

getField in class Expression

getLocalBase

public Expression getLocalBase()

The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

getType

public java.lang.Object getType()

The infered type of this parameter. Please note that the type might not be always initialized to correct value. It might be null if not initialized correctly

getValue

public java.lang.Object getValue(AbstractRecord translationRow,
                                 AbstractSession session)

Extract the value from the row. This may require recusion if it is a nested parameter.

isParameterExpression

public boolean isParameterExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isParameterExpression in class Expression

isValueExpression

public boolean isValueExpression()

INTERNAL:

Overrides:

isValueExpression in class Expression

postCopyIn

protected void postCopyIn(java.util.Dictionary alreadyDone)

INTERNAL: Used for cloning.

Overrides:

postCopyIn in class Expression

printSQL

public void printSQL(ExpressionSQLPrinter printer)

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

Specified by:

printSQL in class Expression

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)

setBaseExpression

protected void setBaseExpression(Expression baseExpression)

The base expression is what the parameter was derived from. This is used for nested parameters.

setLocalBase

public void setLocalBase(Expression localBase)

The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

Overrides:

setLocalBase in class Expression

twistedForBaseAndContext

public Expression twistedForBaseAndContext(Expression newBase,
                                           Expression context)

INTERNAL: Rebuild 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

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

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

writeFields

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

INTERNAL: Append the parameter into the printer. "Normal" ReadQuery never has ParameterExpression in it's select clause hence for a "normal" ReadQuery this method is never called. The reason this method was added is that UpdateAllQuery (in case temporary storage is required) creates a "helper" ReportQuery with ReportItem corresponding to each update expression - and update expression may be a ParameterExpression. The call created by "helper" ReportQuery is never executed - it's used during construction of insert call into temporary storage.

Overrides:

writeFields in class Expression

writeSubexpressionsTo

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

Print the base for debuggin purposes.

Overrides:

writeSubexpressionsTo in class Expression

Throws:

java.io.IOException