Top Description Fields Constructors Methods
org.apache.derby.impl.sql.compile

pack-priv Class GenerationClauseNode

extends ValueNode
Class Inheritance
Imports
java.util.List, org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.reference.SQLState, org.apache.derby.iapi.services.compiler.MethodBuilder, org.apache.derby.iapi.services.context.ContextManager, org.apache.derby.iapi.sql.compile.Visitor, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.depend.ProviderList

This node describes a Generation Clause in a column definition.

Field Summary

Modifier and TypeField and Description
private ProviderList
private ValueNode
private String
private ValueNode
Inherited from org.apache.derby.impl.sql.compile.ValueNode:
transformed

Constructor Summary

AccessConstructor and Description
pack-priv
GenerationClauseNode(ValueNode generationExpression, String expressionText, ContextManager cm)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
acceptChildren(Visitor
the visitor
v
)

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

Accept the visitor for all visitable children of this node.

pack-priv ValueNode
bindExpression(FromList fromList, SubqueryList subqueryList, List<AggregateNode> aggregates)

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

Binding the generation clause.

public List<ColumnReference>
findReferencedColumns()

Return a list of columns referenced in the generation expression.

pack-priv void
generateExpression(ExpressionClassBuilder
The ExpressionClassBuilder for the class being built
acb
,
MethodBuilder
The method the code to place the code
mb
)

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

Generate code for this node.

pack-priv ProviderList
getAuxiliaryProviderList()

Return the auxiliary provider list.

public String
getExpressionText()

Get the defining text of this generation clause

pack-priv boolean
isEquivalent(ValueNode
the node to compare this ValueNode against.
other
)

Implements abstract org.apache.derby.impl.sql.compile.ValueNode.isEquivalent.

Tests if this node is equivalent to the specified ValueNode.

pack-priv void
printSubNodes(int
The depth of this node in the tree
depth
)

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

Prints the sub-nodes of this object.

pack-priv void
setAuxiliaryProviderList(ProviderList apl)

Set the auxiliary provider list.

public String
toString()

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

Convert this object to a String.

Inherited from org.apache.derby.impl.sql.compile.ValueNode:
bindExpressioncategorizechangeToCNFcheckIsBooleancheckTopPredicatesForEqualsConditionsconstantExpressioncopyFieldseliminateNotsevaluateConstantExpressionsgenEqualsFalseTreegenerategenIsNullTreegenSQLJavaSQLTreegetClonegetColumnNamegetConstantValueAsObjectgetDataValueFactorygetOrderableVariantTypegetSchemaNamegetSourceResultColumngetTableNamegetTablesReferencedgetTransformedgetTypeCompilergetTypeIdgetTypeServicesisBinaryEqualsOperatorNodeisBooleanFalseisBooleanTrueisCloneableisConstantExpressionisInListProbeNodeisParameterNodeisRelationalOperatorisSameNodeKindoptimizableEqualityNodepreprocessputAndsOnTopremapColumnReferencesToExpressionsrequiresTypeFromContextselectivitysetCollationInfosetCollationInfosetCollationUsingCompilationSchemasetCollationUsingCompilationSchemasetNullabilitysetTransformedsetTypesetTypesetTypeupdatableByCursorverifyChangeToCNFverifyEliminateNotsverifyPutAndsOnTop

Field Detail

_aplback to summary
private ProviderList _apl
_boundExpressionback to summary
private ValueNode _boundExpression
_expressionTextback to summary
private String _expressionText
_generationExpressionback to summary
private ValueNode _generationExpression

Constructor Detail

GenerationClauseNodeback to summary
pack-priv GenerationClauseNode(ValueNode generationExpression, String expressionText, ContextManager cm)

Method Detail

acceptChildrenback to summary
pack-priv void acceptChildren(Visitor v) throws StandardException

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

Accept the visitor for all visitable children of this node.

Parameters
v:Visitor

the visitor

Annotations
@Override
Exceptions
StandardException:
on error
bindExpressionback to summary
pack-priv ValueNode bindExpression(FromList fromList, SubqueryList subqueryList, List<AggregateNode> aggregates) throws StandardException

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

Binding the generation clause.

Annotations
@Override
findReferencedColumnsback to summary
public List<ColumnReference> findReferencedColumns() throws StandardException

Return a list of columns referenced in the generation expression.

Exceptions
StandardException:
Thrown on error
generateExpressionback to summary
pack-priv void generateExpression(ExpressionClassBuilder acb, MethodBuilder mb) throws StandardException

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

Generate code for this node.

Parameters
acb:ExpressionClassBuilder

The ExpressionClassBuilder for the class being built

mb:MethodBuilder

The method the code to place the code

Annotations
@Override
Exceptions
StandardException:
Thrown on error
getAuxiliaryProviderListback to summary
pack-priv ProviderList getAuxiliaryProviderList()

Return the auxiliary provider list.

getExpressionTextback to summary
public String getExpressionText()

Get the defining text of this generation clause

isEquivalentback to summary
pack-priv boolean isEquivalent(ValueNode other) throws StandardException

Implements abstract org.apache.derby.impl.sql.compile.ValueNode.isEquivalent.

Doc from org.apache.derby.impl.sql.compile.ValueNode.isEquivalent.

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.
Parameters
other:ValueNode

the node to compare this ValueNode against.

Returns:boolean

true if the two nodes are equivalent, false otherwise.

printSubNodesback to summary
pack-priv void printSubNodes(int depth)

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

Prints the sub-nodes of this object. See QueryTreeNode.java for how tree printing is supposed to work.

Parameters
depth:int

The depth of this node in the tree

Annotations
@Override
setAuxiliaryProviderListback to summary
pack-priv void setAuxiliaryProviderList(ProviderList apl)

Set the auxiliary provider list.

toStringback to summary
public String toString()

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

Doc from org.apache.derby.impl.sql.compile.ValueNode.toString.

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

Returns:String

This object as a String

Annotations
@Override