oracle.toplink.essentials.internal.expressions

Class DataExpression

java.lang.Object

oracle.toplink.essentials.expressions.Expression

oracle.toplink.essentials.internal.expressions.DataExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FieldExpression, ObjectExpression, TableExpression

public abstract class DataExpression
extends Expression

Superclass for all expression that have a context. i.e. a base expression.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Expression	baseExpression
protected java.util.Vector	derivedFields
protected java.util.Vector	derivedTables
protected boolean	hasBeenNormalized
protected TableAliasLookup	tableAliases

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

currentAlias, lastTable, selectIfOrderedBy

Constructor Summary

Constructors

Constructor and Description
DataExpression() DataExpression constructor comment.

Method Summary

Modifier and Type	Method and Description
void	addDerivedField(Expression addThis)
void	addDerivedTable(Expression addThis)
DatabaseTable	aliasForTable(DatabaseTable table) INTERNAL: Find the alias for a given table
protected void	assignAlias(DatabaseTable alias, DatabaseTable table) INTERNAL: Alias a particular table within this node
protected void	assignAlias(java.lang.String name, DatabaseTable table) INTERNAL: Alias a particular table within this node
void	clearAliases() INTERNAL:
java.util.Vector	copyCollection(java.util.Vector in, java.util.Dictionary alreadyDone)
Expression	existingDerivedField(DatabaseField field) INTERNAL:
Expression	existingDerivedTable(DatabaseTable table) INTERNAL:
DatabaseField	getAliasedField() INTERNAL: Return the field appropriately aliased
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)
ClassDescriptor	getDescriptor()
DatabaseField	getField() INTERNAL:
Expression	getField(DatabaseField field) ADVANCED: Return an expression representing a field in a data-level query.
Expression	getField(java.lang.String fieldName) ADVANCED: Return an expression representing a field in a data-level query.
DatabaseMapping	getMapping()
java.util.Vector	getOwnedTables() INTERNAL:
QueryKey	getQueryKeyOrNull()
Expression	getTable(DatabaseTable table) ADVANCED: Return an expression representing a table in a data-level query.
Expression	getTable(java.lang.String tableName) ADVANCED: Return an expression representing a table in a data-level query.
TableAliasLookup	getTableAliases() INTERNAL: Return the aliases used.
boolean	hasBeenAliased() INTERNAL: Answers if the database tables associated with this expression have been aliased.
boolean	hasBeenNormalized() INTERNAL: Did the normalizer already add additional joins to the where clause due to this query key representing a foreign reference mapping? This insures that join criteria (for any query key expression) is not added twice.
protected boolean	hasDerivedFields()
protected boolean	hasDerivedTables()
boolean	isAttribute() INTERNAL:
boolean	isDataExpression() INTERNAL:
void	iterateOn(ExpressionIterator iterator) INTERNAL: For iterating using an inner class
Expression	mappingCriteria()
Expression	newDerivedField(DatabaseField field) INTERNAL:
Expression	newDerivedTable(DatabaseTable table) INTERNAL:
Expression	normalize(ExpressionNormalizer normalizer) INTERNAL: Normalize the expression into a printable structure.
protected void	postCopyIn(java.util.Dictionary alreadyDone) INTERNAL: Used for cloning.
void	printSQL(ExpressionSQLPrinter printer) INTERNAL: Print SQL onto the stream, using the ExpressionPrinter for context
protected void	setBaseExpression(Expression e)
void	setHasBeenNormalized(boolean value)
void	setTableAliases(TableAliasLookup tableAliases) INTERNAL: For CR#2456, Table identity involves having two tables sharing the same aliasing table.
java.lang.String	tableAliasesDescription()
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, 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, 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, get, getAllowingNull, getAllowingNull, getClonedField, getFields, 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, 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, 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

derivedTables

protected java.util.Vector derivedTables

derivedFields

protected java.util.Vector derivedFields

baseExpression

protected Expression baseExpression

hasBeenNormalized

protected boolean hasBeenNormalized

tableAliases

protected TableAliasLookup tableAliases

Constructor Detail

DataExpression

public DataExpression()

DataExpression constructor comment.

Method Detail

addDerivedField

public void addDerivedField(Expression addThis)

addDerivedTable

public void addDerivedTable(Expression addThis)

aliasForTable

public DatabaseTable aliasForTable(DatabaseTable table)

INTERNAL: Find the alias for a given table

Overrides:

aliasForTable in class Expression

assignAlias

protected void assignAlias(java.lang.String name,
                           DatabaseTable table)

INTERNAL: Alias a particular table within this node

Overrides:

assignAlias in class Expression

assignAlias

protected void assignAlias(DatabaseTable alias,
                           DatabaseTable table)

INTERNAL: Alias a particular table within this node

clearAliases

public void clearAliases()

INTERNAL:

copyCollection

public java.util.Vector copyCollection(java.util.Vector in,
                                       java.util.Dictionary alreadyDone)

existingDerivedField

public Expression existingDerivedField(DatabaseField field)

INTERNAL:

existingDerivedTable

public Expression existingDerivedTable(DatabaseTable table)

INTERNAL:

getAliasedField

public DatabaseField getAliasedField()

INTERNAL: Return the field appropriately aliased

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

getDescriptor

public ClassDescriptor getDescriptor()

getField

public DatabaseField getField()

INTERNAL:

getField

public Expression getField(java.lang.String fieldName)

Description copied from class: Expression

ADVANCED: Return an expression representing a field in a data-level query. This is used internally in TopLink, or to construct queries involving fields and/or tables that are not mapped.

Example:

  builder.getField("ADDR_ID").greaterThan(100);
  builder.getTable("PROJ_EMP").getField("TYPE").equal("S");
 

Overrides:

getField in class Expression

getField

public Expression getField(DatabaseField field)

Description copied from class: Expression

ADVANCED: Return an expression representing a field in a data-level query. This is used internally in TopLink, or to construct queries involving fields and/or tables that are not mapped.

Example:

  builder.getField(aField).greaterThan(100);
 

Overrides:

getField in class Expression

getMapping

public DatabaseMapping getMapping()

getOwnedTables

public java.util.Vector getOwnedTables()

INTERNAL:

Overrides:

getOwnedTables in class Expression

getQueryKeyOrNull

public QueryKey getQueryKeyOrNull()

getTable

public Expression getTable(java.lang.String tableName)

Description copied from class: Expression

ADVANCED: Return an expression representing a table in a data-level query. This is used internally in TopLink, or to construct queries involving fields and/or tables that are not mapped.

Example:

  builder.getTable("PROJ_EMP").getField("TYPE").equal("S");
 

Overrides:

getTable in class Expression

getTable

public Expression getTable(DatabaseTable table)

Description copied from class: Expression

ADVANCED: Return an expression representing a table in a data-level query. This is used internally in TopLink, or to construct queries involving fields and/or tables that are not mapped.

Example:

  builder.getTable(linkTable).getField("TYPE").equal("S");
 

Overrides:

getTable in class Expression

getTableAliases

public TableAliasLookup getTableAliases()

INTERNAL: Return the aliases used. For CR#2456 must never lazily initialize as also used for Expression identity.

Overrides:

getTableAliases in class Expression

hasBeenNormalized

public boolean hasBeenNormalized()

INTERNAL: Did the normalizer already add additional joins to the where clause due to this query key representing a foreign reference mapping? This insures that join criteria (for any query key expression) is not added twice.

New meaning: DataExpressions are often iterated on multiple times during normalize, but Function/Relation expressions only once. Adding a has been normalized flag improves performance and is required in some applications, such as have temporal query criteria been added.

hasBeenAliased

public boolean hasBeenAliased()

Description copied from class: Expression

INTERNAL: Answers if the database tables associated with this expression have been aliased. This insures the same tables are not aliased twice.

Overrides:

hasBeenAliased in class Expression

hasDerivedFields

protected boolean hasDerivedFields()

hasDerivedTables

protected boolean hasDerivedTables()

isAttribute

public boolean isAttribute()

INTERNAL:

isDataExpression

public boolean isDataExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isDataExpression in class Expression

iterateOn

public void iterateOn(ExpressionIterator iterator)

INTERNAL: For iterating using an inner class

Overrides:

iterateOn in class Expression

mappingCriteria

public Expression mappingCriteria()

newDerivedField

public Expression newDerivedField(DatabaseField field)

INTERNAL:

newDerivedTable

public Expression newDerivedTable(DatabaseTable table)

INTERNAL:

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

setBaseExpression

protected void setBaseExpression(Expression e)

setHasBeenNormalized

public void setHasBeenNormalized(boolean value)

setTableAliases

public void setTableAliases(TableAliasLookup tableAliases)

INTERNAL: For CR#2456, Table identity involves having two tables sharing the same aliasing table.

tableAliasesDescription

public java.lang.String tableAliasesDescription()

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