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

java.lang.Object
  extended byorg.apache.derby.impl.sql.compile.QueryTreeNode
      extended byorg.apache.derby.impl.sql.compile.QueryTreeNodeVector
          extended byorg.apache.derby.impl.sql.compile.ValueNodeList
All Implemented Interfaces:
Visitable

public class ValueNodeList
extends QueryTreeNodeVector

A ValueNodeList represents a list of ValueNodes within a specific predicate (eg, IN list, NOT IN list or BETWEEN) in a DML statement. It extends QueryTreeNodeVector.

Author:
Jerry Brenner

Field Summary
 
Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode
AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX, beginOffset, endOffset
 
Constructor Summary
ValueNodeList()
           
 
Method Summary
 Visitable accept(Visitor v)
          Accept a visitor, and call v.visit() on child nodes as necessary.
 void addElement(QueryTreeNode qt)
           
 void addValueNode(ValueNode valueNode)
          Add a ValueNode to the list.
(package private)  boolean allSamePrecendence(int precedence)
          Return whether or not all of the entries in the list have the same type precendence as the specified value.
 void bindExpression(FromList fromList, SubqueryList subqueryList, java.util.Vector aggregateVector)
          Bind this expression.
 boolean categorize(JBitSet referencedTabs, boolean simplePredsOnly)
          Categorize this predicate.
 void comparable(ValueNode leftOperand)
          Determine whether or not the leftOperand is comparable() with all of the elements in the list.
 void compatible(ValueNode leftOperand)
          Make sure that passed ValueNode's type is compatible with the non-parameter elements in the ValueNodeList.
 boolean constantExpression(PredicateList whereClause)
           
 boolean containsAllConstantNodes()
          Does this list contain all ConstantNodes?
 boolean containsAllParameterNodes()
          Does this list contain all ParameterNodes?
 boolean containsParameterNode()
          Does this list contain a ParameterNode?
 void destructiveAppend(QueryTreeNodeVector qtnv)
           
 QueryTreeNode elementAt(int index)
           
 void genSQLJavaSQLTrees()
          Generate a SQL->Java->SQL conversion tree any node in the list which is not a system built-in type.
 DataTypeDescriptor getDominantTypeServices()
          Get the dominant DataTypeServices from the elements in the list.
protected  int getOrderableVariantType()
          Return the variant type for the underlying expression.
 DataTypeDescriptor getTypeServices()
          Get the first non-null DataTypeServices from the elements in the list.
(package private)  int indexOf(QueryTreeNode qt)
           
(package private)  void insertElementAt(QueryTreeNode qt, int index)
           
 boolean isConstantExpression()
          Return whether or not this expression tree represents a constant expression.
 boolean isNullable()
          Determine whether or not any of the elements in the list are nullable.
 void nondestructiveAppend(QueryTreeNodeVector qtnv)
           
 void preprocess(int numTables, FromList outerFromList, SubqueryList outerSubqueryList, PredicateList outerPredicateList)
          Preprocess a ValueNodeList.
 void printSubNodes(int depth)
          Prints the sub-nodes of this object.
 ValueNodeList remapColumnReferencesToExpressions()
          Remap all ColumnReferences in this tree to be clones of the underlying expression.
(package private)  java.lang.Object remove(int index)
           
(package private)  void removeAllElements()
           
(package private)  void removeElement(QueryTreeNode qt)
           
(package private)  void removeElementAt(int index)
           
 void setClause(int clause)
          Set the clause that this node appears in.
(package private)  void setElementAt(QueryTreeNode qt, int index)
           
 void setParameterDescriptor(DataTypeDescriptor descriptor)
          Set the descriptor for every ParameterNode in the list.
 int size()
           
(package private)  void sortInAscendingOrder(DataValueDescriptor judgeODV)
          Sort the entries in the list in ascending order.
 java.lang.String toString()
          Format this list as a string We can simply iterate through the list.
 
Methods inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode
bind, convertDefaultNode, debugFlush, debugPrint, executeSchemaName, executeStatementName, formatNodeString, foundString, generate, generate, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getContextManager, getCursorInfo, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getGenericConstantActionFactory, getIntProperty, getLanguageConnectionContext, getNodeFactory, getNodeType, getNullNode, getParameterTypes, getRowEstimate, getSchemaDescriptor, getSchemaDescriptor, getSPSName, getStatementType, getTableDescriptor, getTypeCompiler, init, init, init, init, init, init, init, init, init, init, init, init, init, init, isAtomic, isInstanceOf, isSessionSchema, isSessionSchema, makeConstantAction, makeResultDescription, makeTableName, needsSavepoint, nodeHeader, optimize, parseQueryText, printLabel, referencesSessionSchema, resolveTableToSynonym, setBeginOffset, setContextManager, setEndOffset, setNodeType, setRefActionInfo, treePrint, treePrint, verifyClassExist
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ValueNodeList

public ValueNodeList()
Method Detail

printSubNodes

public void printSubNodes(int depth)
Prints the sub-nodes of this object. See QueryTreeNode.java for how tree printing is supposed to work.

Overrides:
printSubNodes in class QueryTreeNode
Parameters:
depth - The depth of this node in the tree
Returns:
Nothing

setClause

public void setClause(int clause)
Set the clause that this node appears in.

Parameters:
clause - The clause that this node appears in.
Returns:
Nothing.

addValueNode

public void addValueNode(ValueNode valueNode)
                  throws StandardException
Add a ValueNode to the list.

Parameters:
valueNode - A ValueNode to add to the list
Returns:
Nothing
Throws:
StandardException - Thrown on error

bindExpression

public void bindExpression(FromList fromList,
                           SubqueryList subqueryList,
                           java.util.Vector aggregateVector)
                    throws StandardException
Bind this expression. This means binding the sub-expressions, as well as figuring out what the return type is for this expression.

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:
Nothing
Throws:
StandardException - Thrown on error

genSQLJavaSQLTrees

public void genSQLJavaSQLTrees()
                        throws StandardException
Generate a SQL->Java->SQL conversion tree any node in the list which is not a system built-in type. This is useful when doing comparisons, built-in functions, etc. on java types which have a direct mapping to system built-in types.

Returns:
Nothing.
Throws:
StandardException - Thrown on error

getDominantTypeServices

public DataTypeDescriptor getDominantTypeServices()
                                           throws StandardException
Get the dominant DataTypeServices from the elements in the list.

Returns:
DataTypeServices The dominant DataTypeServices.
Throws:
StandardException - Thrown on error

getTypeServices

public DataTypeDescriptor getTypeServices()
                                   throws StandardException
Get the first non-null DataTypeServices from the elements in the list.

Returns:
DataTypeServices The first non-null DataTypeServices.
Throws:
StandardException - Thrown on error

allSamePrecendence

boolean allSamePrecendence(int precedence)
Return whether or not all of the entries in the list have the same type precendence as the specified value.

Parameters:
precedence - The specified precedence.
Returns:
Whether or not all of the entries in the list have the same type precendence as the specified value.

compatible

public void compatible(ValueNode leftOperand)
                throws StandardException
Make sure that passed ValueNode's type is compatible with the non-parameter elements in the ValueNodeList.

Parameters:
leftOperand - Check for compatibility against this parameter's type
Throws:
StandardException

comparable

public void comparable(ValueNode leftOperand)
                throws StandardException
Determine whether or not the leftOperand is comparable() with all of the elements in the list. Throw an exception if any of them are not comparable.

Parameters:
leftOperand - The left side of the expression
Returns:
Nothing.
Throws:
StandardException - Thrown on error

isNullable

public boolean isNullable()
Determine whether or not any of the elements in the list are nullable.

Returns:
boolean Whether or not any of the elements in the list are nullable.

containsParameterNode

public boolean containsParameterNode()
Does this list contain a ParameterNode?

Returns:
boolean Whether or not the list contains a ParameterNode

containsAllParameterNodes

public boolean containsAllParameterNodes()
Does this list contain all ParameterNodes?

Returns:
boolean Whether or not the list contains all ParameterNodes

containsAllConstantNodes

public boolean containsAllConstantNodes()
Does this list contain all ConstantNodes?

Returns:
boolean Whether or not the list contains all ConstantNodes

sortInAscendingOrder

void sortInAscendingOrder(DataValueDescriptor judgeODV)
                    throws StandardException
Sort the entries in the list in ascending order. (All values are assumed to be constants.)

Parameters:
judgeODV - In case of type not exactly matching, the judging type.
Returns:
Nothing.
Throws:
StandardException - Thrown on error

setParameterDescriptor

public void setParameterDescriptor(DataTypeDescriptor descriptor)
                            throws StandardException
Set the descriptor for every ParameterNode in the list.

Parameters:
descriptor - The DataTypeServices to set for the parameters
Returns:
Nothing
Throws:
StandardException - Thrown on error

preprocess

public void preprocess(int numTables,
                       FromList outerFromList,
                       SubqueryList outerSubqueryList,
                       PredicateList outerPredicateList)
                throws StandardException
Preprocess a ValueNodeList. For now, we just preprocess each ValueNode in the list.

Parameters:
numTables - Number of tables in the DML Statement
outerFromList - FromList from outer query block
outerSubqueryList - SubqueryList from outer query block
outerPredicateList - PredicateList from outer query block
Returns:
Nothing.
Throws:
StandardException - Thrown on error

remapColumnReferencesToExpressions

public ValueNodeList remapColumnReferencesToExpressions()
                                                 throws StandardException
Remap all ColumnReferences in this tree to be clones of the underlying expression.

Returns:
ValueNodeList The remapped expression tree.
Throws:
StandardException - Thrown on error

isConstantExpression

public boolean isConstantExpression()
Return whether or not this expression tree represents a constant expression.

Returns:
Whether or not this expression tree represents a constant expression.

constantExpression

public boolean constantExpression(PredicateList whereClause)
See Also:
ValueNode.constantExpression(org.apache.derby.impl.sql.compile.PredicateList)

categorize

public boolean categorize(JBitSet referencedTabs,
                          boolean simplePredsOnly)
                   throws StandardException
Categorize this predicate. Initially, this means building a bit map of the referenced tables for each predicate. If the source of this ColumnReference (at the next underlying level) is not a ColumnReference or a VirtualColumnNode then this predicate will not be pushed down. For example, in: select * from (select 1 from s) a (x) where x = 1 we will not push down x = 1. NOTE: It would be easy to handle the case of a constant, but if the inner SELECT returns an arbitrary expression, then we would have to copy that tree into the pushed predicate, and that tree could contain subqueries and method calls. RESOLVE - revisit this issue once we have views.

Parameters:
referencedTabs - JBitSet with bit map of referenced FromTables
simplePredsOnly - Whether or not to consider method calls, field references and conditional nodes when building bit map
Returns:
boolean Whether or not source.expression is a ColumnReference or a VirtualColumnNode.
Throws:
StandardException - Thrown on error

getOrderableVariantType

protected int getOrderableVariantType()
                               throws StandardException
Return the variant type for the underlying expression. The variant type can be: VARIANT - variant within a scan (method calls and non-static field access) SCAN_INVARIANT - invariant within a scan (column references from outer tables) QUERY_INVARIANT - invariant within the life of a query CONSTANT - constant

Returns:
The variant type for the underlying expression.
Throws:
StandardException - thrown on error

size

public final int size()

elementAt

public QueryTreeNode elementAt(int index)

addElement

public final void addElement(QueryTreeNode qt)

removeElementAt

final void removeElementAt(int index)

removeElement

final void removeElement(QueryTreeNode qt)

remove

final java.lang.Object remove(int index)

indexOf

final int indexOf(QueryTreeNode qt)

setElementAt

final void setElementAt(QueryTreeNode qt,
                        int index)

destructiveAppend

public void destructiveAppend(QueryTreeNodeVector qtnv)

nondestructiveAppend

public void nondestructiveAppend(QueryTreeNodeVector qtnv)

removeAllElements

final void removeAllElements()

insertElementAt

final void insertElementAt(QueryTreeNode qt,
                           int index)

toString

public java.lang.String toString()
Format this list as a string We can simply iterate through the list. Note each list member is a QueryTreeNode, and so should have its specialization of toString defined.

Overrides:
toString in class QueryTreeNode
Returns:
This list formatted as a String

accept

public Visitable accept(Visitor v)
                 throws StandardException
Accept a visitor, and call v.visit() on child nodes as necessary.

Specified by:
accept in interface Visitable
Overrides:
accept in class QueryTreeNode
Parameters:
v - the visitor
Throws:
StandardException - on error

Built on Tue 2006-10-10 19:23:47+0200, from revision exported

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.