oracle.toplink.essentials.internal.expressions

Class FunctionExpression

java.lang.Object

oracle.toplink.essentials.expressions.Expression

oracle.toplink.essentials.internal.expressions.FunctionExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FunctionExpression
extends Expression

Used for expressions that have 0 to n children. These include not, between and all functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Expression	baseExpression
protected java.util.Vector	children
protected ExpressionOperator	operator
protected ExpressionOperator	platformOperator
protected java.lang.Class	resultType

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

currentAlias, lastTable, selectIfOrderedBy

Constructor Summary

Constructors

Constructor and Description
FunctionExpression()

Method Summary

Modifier and Type	Method and Description
void	addChild(Expression child)
DatabaseTable	aliasForTable(DatabaseTable table) INTERNAL: Find the alias for a given table
Expression	create(Expression base, java.lang.Object singleArgument, ExpressionOperator operator) INTERNAL:
Expression	create(Expression base, java.util.Vector arguments, ExpressionOperator operator) INTERNAL:
Expression	createWithBaseLast(Expression base, java.lang.Object singleArgument, ExpressionOperator anOperator) INTERNAL: added for Trim support.
java.lang.String	descriptionOfNodeType() INTERNAL: Used for debug printing.
boolean	doesConform(java.lang.Object object, AbstractSession session, AbstractRecord translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean isObjectUnregistered) INTERNAL: Check if the object conforms to the expression in memory.
Expression	getBaseExpression()
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)
java.util.Vector	getChildren()
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.
ExpressionOperator	getOperator() INTERNAL: Most expression have operators, so this is just a convenience method.
ExpressionOperator	getPlatformOperator(DatabasePlatform platform)
java.lang.Class	getResultType()
boolean	hasResultType()
void	initializePlatformOperator(DatabasePlatform platform) INTERNAL:
boolean	isFunctionExpression() INTERNAL:
protected boolean	isObjectComparison() INTERNAL: Return if the represents an object comparison.
void	iterateOn(ExpressionIterator iterator) INTERNAL: For iterating using an inner class
Expression	normalize(ExpressionNormalizer normalizer) INTERNAL: Normalize into a structure that is printable.
protected void	postCopyIn(java.util.Dictionary alreadyDone) INTERNAL: Used for cloning.
void	printInCollection(java.util.Vector items, ExpressionSQLPrinter printer, ExpressionOperator operator) INTERNAL: Print the collection in "IN" onto the SQL stream.
void	printJava(ExpressionJavaPrinter printer) INTERNAL: Print java for project class generation
void	printSQL(ExpressionSQLPrinter printer) INTERNAL: Print SQL
Expression	rebuildOn(Expression newBase) INTERNAL: This expression is built on a different base than the one we want.
void	setBaseExpression(Expression expression) Sets the base of the expression Added to allow creation of functions which take the column name as something other than the first option.
void	setLocalBase(Expression exp) INTERNAL: Set the local base expression, ie the one on the other side of the operator Most types will ignore this, since they don't need it.
void	setOperator(ExpressionOperator theOperator)
void	setResultType(java.lang.Class resultType)
Expression	twistedForBaseAndContext(Expression newBase, Expression context) INTERNAL: Rebuild myself 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: called from SQLSelectStatement.writeFieldsFromExpression(...)
void	writeSubexpressionsTo(java.io.BufferedWriter writer, int indent) INTERNAL: Used in SQL printing.

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, 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, currentDate, currentDateDate, currentTime, currentTimeStamp, dateDifference, dateDifference, dateName, datePart, dateToString, decode, descending, detectExpression, difference, distinct, doesConform, equal, equal, equal, equal, equal, equal, equal, equal, equal, equal, equalOuterJoin, equalOuterJoin, equalsIgnoreCase, equalsIgnoreCase, exists, existsNode, extract, extractPrimaryKeyValues, extractValue, from, fromConstant, fromLiteral, get, get, getAllowingNull, getAllowingNull, getClonedField, getField, getField, getFieldValue, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getName, getNumberVal, 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, isLiteralExpression, isLogicalExpression, isNull, isObjectExpression, 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, 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

baseExpression

protected Expression baseExpression

children

protected java.util.Vector children

operator

protected ExpressionOperator operator

platformOperator

protected transient ExpressionOperator platformOperator

resultType

protected java.lang.Class resultType

Constructor Detail

FunctionExpression

public FunctionExpression()

Method Detail

addChild

public void addChild(Expression child)

aliasForTable

public DatabaseTable aliasForTable(DatabaseTable table)

INTERNAL: Find the alias for a given table

Overrides:

aliasForTable in class Expression

create

public Expression create(Expression base,
                         java.lang.Object singleArgument,
                         ExpressionOperator operator)

INTERNAL:

Overrides:

create in class Expression

createWithBaseLast

public Expression createWithBaseLast(Expression base,
                                     java.lang.Object singleArgument,
                                     ExpressionOperator anOperator)

INTERNAL: added for Trim support. TRIM([trim_character FROM] string_primary)

Overrides:

createWithBaseLast in class Expression

create

public Expression create(Expression base,
                         java.util.Vector arguments,
                         ExpressionOperator operator)

INTERNAL:

Overrides:

create in class Expression

descriptionOfNodeType

public java.lang.String descriptionOfNodeType()

INTERNAL: Used for debug printing.

Overrides:

descriptionOfNodeType in class Expression

doesConform

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

INTERNAL: Check if the object conforms to the expression in memory. This is used for in-memory querying. If the expression in not able to determine if the object conform throw a not supported exception.

Overrides:

doesConform in class Expression

getBaseExpression

public Expression getBaseExpression()

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

getChildren

public java.util.Vector getChildren()

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

getOperator

public ExpressionOperator getOperator()

Description copied from class: Expression

INTERNAL: Most expression have operators, so this is just a convenience method.

Overrides:

getOperator in class Expression

getPlatformOperator

public ExpressionOperator getPlatformOperator(DatabasePlatform platform)

getResultType

public java.lang.Class getResultType()

hasResultType

public boolean hasResultType()

initializePlatformOperator

public void initializePlatformOperator(DatabasePlatform platform)

INTERNAL:

isFunctionExpression

public boolean isFunctionExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isFunctionExpression in class Expression

isObjectComparison

protected boolean isObjectComparison()

INTERNAL: Return if the represents an object comparison.

iterateOn

public void iterateOn(ExpressionIterator iterator)

INTERNAL: For iterating using an inner class

Overrides:

iterateOn in class Expression

normalize

public Expression normalize(ExpressionNormalizer normalizer)

INTERNAL: Normalize into a structure that is printable. Also compute printing information such as outer joins. This checks for object isNull and notNull comparisons.

Overrides:

normalize 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

Specified by:

printSQL in class Expression

printInCollection

public void printInCollection(java.util.Vector items,
                              ExpressionSQLPrinter printer,
                              ExpressionOperator operator)

INTERNAL: Print the collection in "IN" onto the SQL stream. Go through the collection to print out each element.

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

public void setBaseExpression(Expression expression)

Sets the base of the expression Added to allow creation of functions which take the column name as something other than the first option. Creation date: (9/11/00 4:04:03 PM)

Parameters:

expression - oracle.toplink.essentials.expressions.Expression

setLocalBase

public void setLocalBase(Expression exp)

Description copied from class: Expression

INTERNAL: Set the local base expression, ie the one on the other side of the operator Most types will ignore this, since they don't need it.

Overrides:

setLocalBase in class Expression

setOperator

public void setOperator(ExpressionOperator theOperator)

setResultType

public void setResultType(java.lang.Class resultType)

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

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: called from SQLSelectStatement.writeFieldsFromExpression(...)

Overrides:

writeFields in class Expression

writeSubexpressionsTo

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

INTERNAL: Used in SQL printing.

Overrides:

writeSubexpressionsTo in class Expression

Throws:

java.io.IOException