Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.expressions

Class TableExpression

java.lang.Object

org.eclipse.persistence.expressions.Expression

org.eclipse.persistence.internal.expressions.BaseExpression

org.eclipse.persistence.internal.expressions.DataExpression

org.eclipse.persistence.internal.expressions.TableExpression

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

FromSubSelectExpression

public class TableExpression
extends DataExpression

A TableExpression allows for a raw database table to be referenced in a query. This is used for ManyToMany and DirectCollection mappings to define their selection criteria. It can also be used directly to mix SQL artifacts with Expressions.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseTable	table

Fields inherited from class org.eclipse.persistence.internal.expressions.DataExpression

asOfClause, derivedFields, derivedTables, hasBeenNormalized, tableAliases

Fields inherited from class org.eclipse.persistence.internal.expressions.BaseExpression

baseExpression, builder

Fields inherited from class org.eclipse.persistence.expressions.Expression

currentAlias, hashCode, lastTable, selectIfOrderedBy, shouldUseUpperCaseForIgnoreCase

Constructor Summary

Constructors

Constructor	Description
TableExpression()
TableExpression(DatabaseTable table)

Method Summary

Modifier and Type	Method	Description
protected void	assignAlias(DatabaseTable alias, DatabaseTable table)	INTERNAL: Alias a particular table within this node
int	computeHashCode()	INTERNAL: Compute a consistent hash-code for the expression.
String	descriptionOfNodeType()	INTERNAL: Used for debug printing.
boolean	equals(Object object)	INTERNAL: Return if the expression is equal to the other.
Expression	getField(String fieldName)	INTERNAL: Fully-qualify the databaseField if the table is known.
List<DatabaseTable>	getOwnedTables()	INTERNAL:
DatabaseTable	getTable()
boolean	isTableExpression()	INTERNAL:
Expression	normalize(ExpressionNormalizer normalizer)	INTERNAL: Normalize the expression into a printable structure.
Expression	rebuildOn(Expression newBase)	INTERNAL: This expression is built on a different base than the one we want.
void	setTable(DatabaseTable table)	INTERNAL: Added for temporal querying.
Expression	twistedForBaseAndContext(Expression newBase, Expression context, Expression oldBase)	INTERNAL: Rebuild myself against the base, with the values of parameters supplied by the context expression.
void	writeDescriptionOn(BufferedWriter writer)	INTERNAL: Used to print a debug form of the expression tree.

Methods inherited from class org.eclipse.persistence.internal.expressions.DataExpression

addDerivedField, addDerivedTable, aliasForTable, asOf, assignAlias, clearAliases, copyCollection, existingDerivedField, existingDerivedTable, getAlias, getAliasedField, getAsOfClause, getContainingDescriptor, getDescriptor, getField, getField, getMapping, getQueryKeyOrNull, getTable, getTable, getTableAliases, hasAsOfClause, hasBeenAliased, hasBeenNormalized, hasDerivedFields, hasDerivedTables, isAttribute, isDataExpression, iterateOn, newDerivedField, newDerivedTable, postCopyIn, printSQL, setHasBeenNormalized, setTableAliases, tableAliasesDescription, writeSubexpressionsTo

Methods inherited from class org.eclipse.persistence.internal.expressions.BaseExpression

getBaseExpression, getBuilder, resetPlaceHolderBuilder, setBaseExpression, shallowClone

Methods inherited from class org.eclipse.persistence.expressions.Expression

addDate, addDate, addMonths, addMonths, alias, 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, anyOf, anyOfAllowingNone, anyOfAllowingNone, as, ascending, asciiValue, assignTableAliasesStartingAt, average, between, between, between, between, between, between, between, between, between, caseConditionStatement, caseConditionStatement, caseStatement, caseStatement, cast, clone, cloneUsing, coalesce, coalesce, 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, difference, distinct, doesConform, doesConform, equal, equal, equal, equal, equal, equal, equal, equal, equal, equal, equalOuterJoin, equalOuterJoin, equalsIgnoreCase, equalsIgnoreCase, except, except, exceptAll, exceptAll, exists, existsNode, extract, extractFields, extractPrimaryKeyValues, extractValue, extractValues, extractXml, from, fromConstant, fromLiteral, get, get, getAllowingNull, getAsOfClauseRecursively, getClonedField, getFields, getFieldValue, getFunction, getFunction, getFunction, getFunction, getFunctionWithArguments, getLeafDescriptor, getLeafMapping, getName, getNumberVal, getOperator, getOperator, getParameter, getParameter, getParameter, getProperty, getSelectionFields, getSelectionFields, getSession, getStringVal, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, greaterThanEqual, hashCode, hexToRaw, ifNull, in, in, in, in, in, in, in, in, in, in, in, in, index, indexOf, intersect, intersect, intersectAll, intersectAll, isClassTypeExpression, isCompoundExpression, isConstantExpression, isEmpty, isExpressionBuilder, isFieldExpression, isFragment, isFunctionExpression, isLiteralExpression, isLogicalExpression, isMapEntryExpression, isNull, isObjectExpression, isParameterExpression, isQueryKeyExpression, isRelationExpression, isSubSelectExpression, isTreatExpression, isValueExpression, join, lastDay, leftJoin, 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, localDate, localDateTime, localTime, locate, locate, locate, mapEntry, mapKey, 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, notLike, notLike, notNull, nullIf, nullsFirst, nullsLast, operator, or, performOperator, postfixSQL, prefixSQL, printJava, ref, regexp, regexp, registerIn, replace, replicate, replicate, resetCache, reverse, right, right, rightPad, rightPad, rightTrim, rightTrim, roundDate, selectIfOrderedBy, setLocalBase, setSelectIfOrderedBy, size, size, some, some, some, some, some, some, some, some, some, some, some, some, sql, standardDeviation, subQuery, substring, substring, substring, substring, sum, toChar, toChar, toCharacter, toDate, toLowerCase, toNumber, toString, toString, toUpperCase, toUppercaseCasedWords, translate, treat, trim, trim, truncateDate, twist, type, union, union, unionAll, unionAll, validateNode, value, value, value, value, value, value, value, value, value, value, valueFromObject, valueFromObject, variance, writeAlias, writeField, writeFields

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

table

protected DatabaseTable table

Constructor Details

TableExpression

public TableExpression()

TableExpression

public TableExpression(DatabaseTable table)

Method Details

assignAlias

protected void assignAlias(DatabaseTable alias,
 DatabaseTable table)

INTERNAL: Alias a particular table within this node

Overrides:

assignAlias in class DataExpression

equals

public boolean equals(Object object)

INTERNAL: Return if the expression is equal to the other. This is used to allow dynamic expression's SQL to be cached.

Overrides:

equals in class DataExpression

computeHashCode

public int computeHashCode()

INTERNAL: Compute a consistent hash-code for the expression. This is used to allow dynamic expression's SQL to be cached.

Overrides:

computeHashCode in class Expression

descriptionOfNodeType

public String descriptionOfNodeType()

INTERNAL: Used for debug printing.

Overrides:

descriptionOfNodeType in class Expression

getField

public Expression getField(String fieldName)

INTERNAL: Fully-qualify the databaseField if the table is known. CR 3791

Overrides:

getField in class DataExpression

getOwnedTables

public List<DatabaseTable> getOwnedTables()

INTERNAL:

Overrides:

getOwnedTables in class Expression

getTable

public DatabaseTable getTable()

isTableExpression

public boolean isTableExpression()

Description copied from class: Expression

INTERNAL:

Overrides:

isTableExpression in class Expression

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

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)

setTable

public void setTable(DatabaseTable table)

INTERNAL: Added for temporal querying.

twistedForBaseAndContext

public Expression twistedForBaseAndContext(Expression newBase,
 Expression context,
 Expression oldBase)

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

writeDescriptionOn

public void writeDescriptionOn(BufferedWriter writer)
                        throws IOException

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

Overrides:

writeDescriptionOn in class Expression

Throws:

IOException