oracle.toplink.essentials.internal.expressions

Class FieldExpression

java.lang.Object

oracle.toplink.essentials.expressions.Expression

oracle.toplink.essentials.internal.expressions.DataExpression

oracle.toplink.essentials.internal.expressions.FieldExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FieldExpression
extends DataExpression

Field expressions represent a field of a table. Their base is either a table or object expression. This is used for mapping queries and to allow queries on non-mapped field or tables.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseField	aliasedField
protected DatabaseField	field

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
FieldExpression() FieldExpression constructor comment.
FieldExpression(DatabaseField newField) FieldExpression constructor comment.
FieldExpression(DatabaseField newField, Expression myBase) FieldExpression constructor comment.

Method Summary

Modifier and Type	Method and Description
void	clearAliases() INTERNAL:
java.lang.String	descriptionOfNodeType() INTERNAL: Used for debug printing.
DatabaseField	getAliasedField() INTERNAL: Return the field appropriately aliased
DatabaseField	getClonedField() INTERNAL: If there are any fields associated with this expression, return them
java.util.Vector	getClonedFields() INTERNAL: If there are any fields associated with this expression, return them
DatabaseField	getField() INTERNAL:
java.util.Vector	getFields() INTERNAL: Return all the fields
boolean	isAttribute() INTERNAL:
boolean	isFieldExpression() INTERNAL:
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.
void	setField(DatabaseField newField) INTERNAL: Set the field in the mapping.
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.
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(...)

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

addDerivedField, addDerivedTable, aliasForTable, assignAlias, assignAlias, copyCollection, existingDerivedField, existingDerivedTable, getBaseExpression, getBuilder, getDescriptor, getField, getField, getMapping, getOwnedTables, getQueryKeyOrNull, getTable, getTable, getTableAliases, hasBeenAliased, hasBeenNormalized, hasDerivedFields, hasDerivedTables, isDataExpression, iterateOn, mappingCriteria, newDerivedField, newDerivedTable, normalize, postCopyIn, 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, anyOf, 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, get, getAllowingNull, getAllowingNull, 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, isFragment, isFunctionExpression, 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, 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

Methods inherited from class java.lang.Object

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

Field Detail

field

protected DatabaseField field

aliasedField

protected transient DatabaseField aliasedField

Constructor Detail

FieldExpression

public FieldExpression()

FieldExpression constructor comment.

FieldExpression

public FieldExpression(DatabaseField newField)

FieldExpression constructor comment.

FieldExpression

public FieldExpression(DatabaseField newField,
                       Expression myBase)

FieldExpression constructor comment.

Method Detail

clearAliases

public void clearAliases()

INTERNAL:

Overrides:

clearAliases in class DataExpression

descriptionOfNodeType

public java.lang.String descriptionOfNodeType()

INTERNAL: Used for debug printing.

Overrides:

descriptionOfNodeType in class Expression

getAliasedField

public DatabaseField getAliasedField()

INTERNAL: Return the field appropriately aliased

Overrides:

getAliasedField in class DataExpression

getClonedField

public DatabaseField getClonedField()

INTERNAL: If there are any fields associated with this expression, return them

Overrides:

getClonedField in class Expression

getClonedFields

public java.util.Vector getClonedFields()

INTERNAL: If there are any fields associated with this expression, return them

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 Expression

isAttribute

public boolean isAttribute()

INTERNAL:

Overrides:

isAttribute in class DataExpression

isFieldExpression

public boolean isFieldExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isFieldExpression in class 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)

setField

public void setField(DatabaseField newField)

INTERNAL: Set the field in the mapping.

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

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