Class CurrentRowLocationNode

java.lang.Object

org.apache.derby.impl.sql.compile.QueryTreeNode

org.apache.derby.impl.sql.compile.ValueNode

org.apache.derby.impl.sql.compile.CurrentRowLocationNode

All Implemented Interfaces:

Visitable

class CurrentRowLocationNode
extends ValueNode

The CurrentRowLocation operator is used by DELETE and UPDATE to get the RowLocation of the current row for the target table. The bind() operations for DELETE and UPDATE add a column to the target list of the SelectNode that represents the ResultSet to be deleted or updated.

Field Summary

Fields inherited from class ValueNode

transformed

Fields inherited from class QueryTreeNode

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_CYCLE, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX

Constructor Summary

Constructors

Constructor	Description
CurrentRowLocationNode(ContextManager cm)

Method Summary

Modifier and Type	Method	Description
(package private) ValueNode	bindExpression(FromList fromList, SubqueryList subqueryList, List<AggregateNode> aggregates)	Binding this expression means setting the result DataTypeServices.
(package private) void	generateExpression(ExpressionClassBuilder acb, MethodBuilder mbex)	CurrentRowLocationNode is used in updates and deletes.
(package private) boolean	isEquivalent(ValueNode o)	Tests if this node is equivalent to the specified ValueNode.

Methods inherited from class ValueNode

bindExpression, categorize, changeToCNF, checkIsBoolean, checkTopPredicatesForEqualsConditions, constantExpression, copyFields, eliminateNots, evaluateConstantExpressions, genEqualsFalseTree, generate, genIsNullTree, genSQLJavaSQLTree, getClone, getColumnName, getConstantValueAsObject, getDataValueFactory, getOrderableVariantType, getSchemaName, getSourceResultColumn, getTableName, getTablesReferenced, getTransformed, getTypeCompiler, getTypeId, getTypeServices, isBinaryEqualsOperatorNode, isBooleanFalse, isBooleanTrue, isCloneable, isConstantExpression, isInListProbeNode, isParameterNode, isRelationalOperator, isSameNodeKind, optimizableEqualityNode, preprocess, putAndsOnTop, remapColumnReferencesToExpressions, requiresTypeFromContext, selectivity, setCollationInfo, setCollationInfo, setCollationUsingCompilationSchema, setCollationUsingCompilationSchema, setNullability, setTransformed, setType, setType, setType, toString, updatableByCursor, verifyChangeToCNF, verifyEliminateNots, verifyPutAndsOnTop

Methods inherited from class QueryTreeNode

accept, acceptChildren, addTag, addUDTUsagePriv, addUDTUsagePriv, bindOffsetFetch, bindRowMultiSet, bindUserCatalogType, bindUserType, checkReliability, checkReliability, convertDefaultNode, copyTagsFrom, createTypeDependency, debugFlush, debugPrint, disablePrivilegeCollection, formatNodeString, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getContext, getContextManager, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getGenericConstantActionFactory, getIntProperty, getLanguageConnectionContext, getLongProperty, getNullNode, getOffsetOrderedNodes, getOptimizerFactory, getOptimizerTracer, getParameterTypes, getSchemaDescriptor, getSchemaDescriptor, getStatementType, getTableDescriptor, getTypeCompiler, getUDTDesc, isAtomic, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeConstantAction, makeTableName, makeTableName, nodeHeader, optimizerTracingIsOn, orReliability, parseSearchCondition, parseStatement, printLabel, printSubNodes, referencesSessionSchema, resolveTableToSynonym, setBeginOffset, setEndOffset, setRefActionInfo, stackPrint, taggedWith, treePrint, treePrint, verifyClassExist

Methods inherited from class Object

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

Constructor Details

CurrentRowLocationNode

CurrentRowLocationNode(ContextManager cm)

Method Details

bindExpression

ValueNode bindExpression(FromList fromList,
 SubqueryList subqueryList,
 List<AggregateNode> aggregates)
                  throws StandardException

Binding this expression means setting the result DataTypeServices. In this case, the result type is always the same.

Overrides:

bindExpression in class ValueNode

Parameters:

fromList - The FROM list for the statement. This parameter is not used in this case.

subqueryList - The subquery list being built as we find SubqueryNodes

aggregates - The aggregate list being built as we find AggregateNodes

Returns:

The new top of the expression tree.

Throws:

StandardException - Thrown on error

generateExpression

void generateExpression(ExpressionClassBuilder acb,
 MethodBuilder mbex)
                 throws StandardException

CurrentRowLocationNode is used in updates and deletes. See generate() in UpdateNode and DeleteNode to get the full overview of generate(). This class is responsible for generating the method that will return the RowLocation for the next row to be updated or deleted. This routine will generate a method of the form: private SQLRef fieldx; ... protected DataValueDescriptor exprx() throws StandardException { return fieldx = ( "result set member".getRowLocation(), fieldx); } and return the generated code: exprx() ("result set member" is a member of the generated class added by UpdateNode or DeleteNode.) This exprx function is used within another exprx function, and so doesn't need a static field or to be public; but at present, it has both. fieldx is a generated field that is initialized to null when the activation is constructed. getSQLRef will re-use fieldx on calls after the first call, rather than allocate a new SQLRef for each call.

Overrides:

generateExpression in class ValueNode

Parameters:

acb - The ExpressionClassBuilder for the class being built

mbex - The method the expression will go into

Throws:

StandardException - Thrown on error

isEquivalent

boolean isEquivalent(ValueNode o)

Description copied from class: ValueNode

Tests if this node is equivalent to the specified ValueNode. Two ValueNodes are considered equivalent if they will evaluate to the same value during query execution.

This method provides basic expression matching facility for the derived class of ValueNode and it is used by the language layer to compare the node structural form of the two expressions for equivalence at bind phase.

Note that it is not comparing the actual row values at runtime to produce a result; hence, when comparing SQL NULLs, they are considered to be equivalent and not unknown.

One usage case of this method in this context is to compare the select column expression against the group by expression to check if they are equivalent. e.g.:

SELECT c1+c2 FROM t1 GROUP BY c1+c2

In general, node equivalence is determined by the derived class of ValueNode. But they generally abide to the rules below:

• The two ValueNodes must be of the same node type to be considered equivalent. e.g.: CastNode vs. CastNode - equivalent (if their args also match), ColumnReference vs CastNode - not equivalent.
• If node P contains other ValueNode(s) and so on, those node(s) must also be of the same node type to be considered equivalent.
• If node P takes a parameter list, then the number of arguments and its arguments for the two nodes must also match to be considered equivalent. e.g.: CAST(c1 as INTEGER) vs CAST(c1 as SMALLINT), they are not equivalent.
• When comparing SQL NULLs in this context, they are considered to be equivalent.
• If this does not apply or it is determined that the two nodes are not equivalent then the derived class of this method should return false; otherwise, return true.

Specified by:

isEquivalent in class ValueNode

Parameters:

o - the node to compare this ValueNode against.

Returns:

true if the two nodes are equivalent, false otherwise.