org.apache.derby.impl.sql.compile
Class NextSequenceNode

java.lang.Object
  org.apache.derby.impl.sql.compile.QueryTreeNode
      org.apache.derby.impl.sql.compile.ValueNode
          org.apache.derby.impl.sql.compile.NextSequenceNode

All Implemented Interfaces:

Node, Visitable

public class NextSequenceNode
extends ValueNode

A class that represents a value obtained from a Sequence using 'NEXT VALUE'

Field Summary

private SequenceDescriptor	sequenceDescriptor
private TableName	sequenceName

Fields inherited from class org.apache.derby.impl.sql.compile.ValueNode

transformed

Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX, isPrivilegeCollectionRequired

Constructor Summary

NextSequenceNode()

Method Summary

ValueNode	bindExpression(FromList fromList, SubqueryList subqueryList, java.util.List aggregateVector, boolean forQueryRewrite) Bind this expression.
void	generateConstant(ExpressionClassBuilder ecb, MethodBuilder mb) Dummy implementation to return a constant.
void	generateExpression(ExpressionClassBuilder acb, MethodBuilder mb) Generate code for this calculation.
void	init(java.lang.Object sequenceName) Initializer for a NextSequenceNode
protected boolean	isEquivalent(ValueNode other) Tests if this node is equivalent to the specified ValueNode.
java.lang.String	toString() Convert this object to a String.

Methods inherited from class org.apache.derby.impl.sql.compile.ValueNode

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

Methods inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

accept, acceptChildren, bindOffsetFetch, bindRowMultiSet, bindUserCatalogType, bindUserType, checkReliability, checkReliability, convertDefaultNode, createTypeDependency, debugFlush, debugPrint, disablePrivilegeCollection, formatNodeString, foundString, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getContextManager, getCursorInfo, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getGenericConstantActionFactory, getIntProperty, getLanguageConnectionContext, getNodeFactory, getNodeType, getNullNode, getParameterTypes, getSchemaDescriptor, getSchemaDescriptor, getStatementType, getTableDescriptor, getTypeCompiler, init, init, init, init, init, init, init, init, init, init, init, init, isAtomic, isInstanceOf, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeConstantAction, makeTableName, makeTableName, nodeHeader, orReliability, parseStatement, printLabel, printSubNodes, referencesSessionSchema, resolveTableToSynonym, setBeginOffset, setContextManager, setEndOffset, setNodeType, setRefActionInfo, stackPrint, treePrint, treePrint, verifyClassExist

Methods inherited from class java.lang.Object

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

Field Detail

sequenceName

private TableName sequenceName

sequenceDescriptor

private SequenceDescriptor sequenceDescriptor

Constructor Detail

NextSequenceNode

public NextSequenceNode()

Method Detail

init

public void init(java.lang.Object sequenceName)
          throws StandardException

Initializer for a NextSequenceNode

Specified by:

init in interface Node

Overrides:

init in class QueryTreeNode

Parameters:

sequenceName - The name of the sequence being called

Throws:

StandardException - Thrown on error

bindExpression

public ValueNode bindExpression(FromList fromList,
                                SubqueryList subqueryList,
                                java.util.List aggregateVector,
                                boolean forQueryRewrite)
                         throws StandardException

Bind this expression. This means binding the sub-expressions, as well as figuring out what the return type is for this expression.

Overrides:

bindExpression in class ValueNode

Parameters:

fromList - The FROM list for the query this expression is in, for binding columns.

subqueryList - The subquery list being built as we find SubqueryNodes

aggregateVector - The aggregate vector being built as we find AggregateNodes

Returns:

The new top of the expression tree.

Throws:

StandardException - Thrown on error

generateExpression

public void generateExpression(ExpressionClassBuilder acb,
                               MethodBuilder mb)
                        throws StandardException

Description copied from class: ValueNode

Generate code for this calculation. This is a place-holder method - it should not be called.

Overrides:

generateExpression in class ValueNode

Parameters:

acb - The ExpressionClassBuilder for the class being built

mb - The method the expression will go into

Throws:

StandardException - Thrown on error

generateConstant

public void generateConstant(ExpressionClassBuilder ecb,
                             MethodBuilder mb)
                      throws StandardException

Dummy implementation to return a constant. Will be replaced with actual NEXT VALUE logic.

Parameters:

ecb - The ExpressionClassBuilder for the class being built

mb - The method the expression will go into

Throws:

StandardException - on error

toString

public java.lang.String toString()

Convert this object to a String. See comments in QueryTreeNode.java for how this should be done for tree printing.

Overrides:

toString in class ValueNode

Returns:

This object as a String

isEquivalent

protected boolean isEquivalent(ValueNode other)
                        throws StandardException

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:

other - the node to compare this ValueNode against.

Returns:

true if the two nodes are equivalent, false otherwise.

Throws:

StandardException