org.apache.derby.impl.sql.compile

Class BinaryOperatorNode

java.lang.Object

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

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

org.apache.derby.impl.sql.compile.OperatorNode

org.apache.derby.impl.sql.compile.BinaryOperatorNode

All Implemented Interfaces:

Node, Visitable

Direct Known Subclasses:

BinaryArithmeticOperatorNode, BinaryComparisonOperatorNode, BinaryLogicalOperatorNode, ConcatenationOperatorNode, TimestampOperatorNode

public class BinaryOperatorNode
extends OperatorNode

A BinaryOperatorNode represents a built-in binary operator as defined by the ANSI/ISO SQL standard. This covers operators like +, -, *, /, =, <, etc. Java operators are not represented here: the JSQL language allows Java methods to be called from expressions, but not Java operators.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AND
(package private) static java.lang.String[][]	BinaryArgTypes
(package private) static java.lang.String[]	BinaryMethodNames
(package private) static java.lang.String[]	BinaryOperators
(package private) static java.lang.String[]	BinaryResultTypes
static int	CONCATENATE
static int	DIVIDE
static int	EQ
static int	GE
static int	GT
static int	LE
(package private) java.lang.String	leftInterfaceType
(package private) ValueNode	leftOperand
static int	LIKE
static int	LT
(package private) java.lang.String	methodName
static int	MINUS
static int	NE
(package private) java.lang.String	operator
(package private) int	operatorType
static int	OR
static int	PLUS
(package private) ValueNode	receiver
(package private) java.lang.String	resultInterfaceType
(package private) java.lang.String	rightInterfaceType
(package private) ValueNode	rightOperand
static int	TIMES
static int	XMLEXISTS_OP
private java.lang.String	xmlQuery The query expression if the operator is XMLEXISTS or XMLQUERY.
static int	XMLQUERY_OP

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

Constructor Summary

Constructors

Constructor and Description
BinaryOperatorNode()

Method Summary

Modifier and Type	Method and Description
(package private) void	acceptChildren(Visitor v) Accept the visitor for all visitable children of this node.
ValueNode	bindExpression(FromList fromList, SubqueryList subqueryList, java.util.List aggregateVector) Bind this expression.
ValueNode	bindXMLQuery() Bind an XMLEXISTS or XMLQUERY operator.
boolean	categorize(JBitSet referencedTabs, boolean simplePredsOnly) Categorize this predicate.
boolean	constantExpression(PredicateList whereClause) Return whether or not this expression tree represents a constant value.
void	generateExpression(ExpressionClassBuilder acb, MethodBuilder mb) Do code generation for this binary operator.
ValueNode	genSQLJavaSQLTree() generate a SQL->Java->SQL conversion tree above the left and right operand of this Binary Operator Node if needed.
ValueNode	getLeftOperand() Get the leftOperand
protected int	getOrderableVariantType() Return the variant type for the underlying expression.
java.lang.String	getReceiverInterfaceName() Determine the type the binary method is called on.
ValueNode	getRightOperand() Get the rightOperand
void	init(java.lang.Object leftOperand, java.lang.Object rightOperand, java.lang.Object opType) Initializer for a BinaryOperatorNode
void	init(java.lang.Object leftOperand, java.lang.Object rightOperand, java.lang.Object leftInterfaceType, java.lang.Object rightInterfaceType) Initialize a query tree node.
void	init(java.lang.Object leftOperand, java.lang.Object rightOperand, java.lang.Object operator, java.lang.Object methodName, java.lang.Object leftInterfaceType, java.lang.Object rightInterfaceType) Initializer for a BinaryOperatorNode
boolean	isConstantExpression() Return whether or not this expression tree represents a constant expression.
protected boolean	isEquivalent(ValueNode o) Tests if this node is equivalent to the specified ValueNode.
ValueNode	preprocess(int numTables, FromList outerFromList, SubqueryList outerSubqueryList, PredicateList outerPredicateList) Preprocess an expression tree.
void	printSubNodes(int depth) Prints the sub-nodes of this object.
ValueNode	remapColumnReferencesToExpressions() Remap all ColumnReferences in this tree to be clones of the underlying expression.
void	setLeftOperand(ValueNode newLeftOperand) Set the leftOperand to the specified ValueNode
void	setLeftRightInterfaceType(java.lang.String iType) Set the interface type for the left and right arguments.
(package private) void	setMethodName(java.lang.String methodName) Set the methodName.
(package private) void	setOperator(java.lang.String operator) Set the operator.
void	setRightOperand(ValueNode newRightOperand) Set the rightOperand to the specified ValueNode
java.lang.String	toString() Convert this object to a String.

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

pushSqlXmlUtil

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

bindExpression, changeToCNF, checkIsBoolean, checkTopPredicatesForEqualsConditions, copyFields, eliminateNots, evaluateConstantExpressions, genEqualsFalseTree, generate, generateFilter, genIsNullTree, getClone, getColumnName, getConstantValueAsObject, getDataValueFactory, getSchemaName, getSourceResultColumn, getTableName, getTablesReferenced, getTransformed, getTypeCompiler, getTypeId, getTypeServices, init, isBinaryEqualsOperatorNode, isBooleanFalse, isBooleanTrue, isCloneable, isInListProbeNode, isParameterNode, isRelationalOperator, isSameNodeType, optimizableEqualityNode, putAndsOnTop, 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, 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, isAtomic, isInstanceOf, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeConstantAction, makeTableName, makeTableName, nodeHeader, orReliability, parseStatement, printLabel, 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

operator

java.lang.String operator

methodName

java.lang.String methodName

receiver

ValueNode receiver

PLUS

public static final int PLUS

See Also:

Constant Field Values

MINUS

public static final int MINUS

See Also:

Constant Field Values

TIMES

public static final int TIMES

See Also:

Constant Field Values

DIVIDE

public static final int DIVIDE

See Also:

Constant Field Values

CONCATENATE

public static final int CONCATENATE

See Also:

Constant Field Values

EQ

public static final int EQ

See Also:

Constant Field Values

NE

public static final int NE

See Also:

Constant Field Values

GT

public static final int GT

See Also:

Constant Field Values

GE

public static final int GE

See Also:

Constant Field Values

LT

public static final int LT

See Also:

Constant Field Values

LE

public static final int LE

See Also:

Constant Field Values

AND

public static final int AND

See Also:

Constant Field Values

OR

public static final int OR

See Also:

Constant Field Values

LIKE

public static final int LIKE

See Also:

Constant Field Values

leftOperand

ValueNode leftOperand

rightOperand

ValueNode rightOperand

leftInterfaceType

java.lang.String leftInterfaceType

rightInterfaceType

java.lang.String rightInterfaceType

resultInterfaceType

java.lang.String resultInterfaceType

operatorType

int operatorType

XMLEXISTS_OP

public static final int XMLEXISTS_OP

See Also:

Constant Field Values

XMLQUERY_OP

public static final int XMLQUERY_OP

See Also:

Constant Field Values

BinaryOperators

static final java.lang.String[] BinaryOperators

BinaryMethodNames

static final java.lang.String[] BinaryMethodNames

BinaryResultTypes

static final java.lang.String[] BinaryResultTypes

BinaryArgTypes

static final java.lang.String[][] BinaryArgTypes

xmlQuery

private java.lang.String xmlQuery

The query expression if the operator is XMLEXISTS or XMLQUERY.

Constructor Detail

BinaryOperatorNode

public BinaryOperatorNode()

Method Detail

init

public void init(java.lang.Object leftOperand,
                 java.lang.Object rightOperand,
                 java.lang.Object operator,
                 java.lang.Object methodName,
                 java.lang.Object leftInterfaceType,
                 java.lang.Object rightInterfaceType)

Initializer for a BinaryOperatorNode

Specified by:

init in interface Node

Overrides:

init in class QueryTreeNode

Parameters:

leftOperand - The left operand of the node

rightOperand - The right operand of the node

operator - The name of the operator

methodName - The name of the method to call for this operator

leftInterfaceType - The name of the interface for the left operand

rightInterfaceType - The name of the interface for the right operand

init

public void init(java.lang.Object leftOperand,
                 java.lang.Object rightOperand,
                 java.lang.Object leftInterfaceType,
                 java.lang.Object rightInterfaceType)

Description copied from class: QueryTreeNode

Initialize a query tree node.

Specified by:

init in interface Node

Overrides:

init in class QueryTreeNode

init

public void init(java.lang.Object leftOperand,
                 java.lang.Object rightOperand,
                 java.lang.Object opType)

Initializer for a BinaryOperatorNode

Specified by:

init in interface Node

Overrides:

init in class QueryTreeNode

Parameters:

leftOperand - The left operand of the node

rightOperand - The right operand of the node

opType - An Integer holding the operatorType for this operator.

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

setOperator

void setOperator(java.lang.String operator)

Set the operator.

Parameters:

operator - The operator.

setMethodName

void setMethodName(java.lang.String methodName)

Set the methodName.

Parameters:

methodName - The methodName.

setLeftRightInterfaceType

public void setLeftRightInterfaceType(java.lang.String iType)

Set the interface type for the left and right arguments. Used when we don't know the interface type until later in binding.

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

bindExpression

public ValueNode bindExpression(FromList fromList,
                                SubqueryList subqueryList,
                                java.util.List 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.

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

bindXMLQuery

public ValueNode bindXMLQuery()
                       throws StandardException

Bind an XMLEXISTS or XMLQUERY operator. Makes sure the operand type and target type are both correct and sets the result type.

Throws:

StandardException - Thrown on error

genSQLJavaSQLTree

public ValueNode genSQLJavaSQLTree()
                            throws StandardException

generate a SQL->Java->SQL conversion tree above the left and right operand of this Binary Operator Node if needed. Subclasses can override the default behavior.

Overrides:

genSQLJavaSQLTree in class ValueNode

Returns:

ValueNode The new tree.

Throws:

StandardException - Thrown on error

preprocess

public ValueNode preprocess(int numTables,
                            FromList outerFromList,
                            SubqueryList outerSubqueryList,
                            PredicateList outerPredicateList)
                     throws StandardException

Preprocess an expression tree. We do a number of transformations here (including subqueries, IN lists, LIKE and BETWEEN) plus subquery flattening. NOTE: This is done before the outer ResultSetNode is preprocessed.

Overrides:

preprocess in class ValueNode

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:

The modified expression

Throws:

StandardException - Thrown on error

generateExpression

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

Do code generation for this binary operator.

Overrides:

generateExpression in class ValueNode

Parameters:

acb - The ExpressionClassBuilder for the class we're generating

mb - The method the code to place the code

Throws:

StandardException - Thrown on error

setLeftOperand

public void setLeftOperand(ValueNode newLeftOperand)

Set the leftOperand to the specified ValueNode

Parameters:

newLeftOperand - The new leftOperand

getLeftOperand

public ValueNode getLeftOperand()

Get the leftOperand

Returns:

The current leftOperand.

setRightOperand

public void setRightOperand(ValueNode newRightOperand)

Set the rightOperand to the specified ValueNode

Parameters:

newRightOperand - The new rightOperand

getRightOperand

public ValueNode getRightOperand()

Get the rightOperand

Returns:

The current rightOperand.

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.

Overrides:

categorize in class ValueNode

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

remapColumnReferencesToExpressions

public ValueNode remapColumnReferencesToExpressions()
                                             throws StandardException

Remap all ColumnReferences in this tree to be clones of the underlying expression.

Overrides:

remapColumnReferencesToExpressions in class ValueNode

Returns:

ValueNode The remapped expression tree.

Throws:

StandardException - Thrown on error

isConstantExpression

public boolean isConstantExpression()

Return whether or not this expression tree represents a constant expression.

Overrides:

isConstantExpression in class ValueNode

Returns:

Whether or not this expression tree represents a constant expression.

constantExpression

public boolean constantExpression(PredicateList whereClause)

Description copied from class: ValueNode

Return whether or not this expression tree represents a constant value. In this case, "constant" means that it will always evaluate to the same thing, even if it includes columns. A column is constant if it is compared to a constant expression.

Overrides:

constantExpression in class ValueNode

Returns:

True means this expression tree represents a constant value.

See Also:

ValueNode.constantExpression(org.apache.derby.impl.sql.compile.PredicateList)

getReceiverInterfaceName

public java.lang.String getReceiverInterfaceName()
                                          throws StandardException

Determine the type the binary method is called on. By default, based on the receiver. Override in nodes that use methods on super-interfaces of the receiver's interface, such as comparisons.

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 - immutable

Overrides:

getOrderableVariantType in class ValueNode

Returns:

The variant type for the underlying expression.

Throws:

StandardException - thrown on error

acceptChildren

void acceptChildren(Visitor v)
             throws StandardException

Accept the visitor for all visitable children of this node.

Overrides:

acceptChildren in class QueryTreeNode

Parameters:

v - the visitor

Throws:

StandardException - on error

isEquivalent

protected boolean isEquivalent(ValueNode o)
                        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:

o - the node to compare this ValueNode against.

Returns:

true if the two nodes are equivalent, false otherwise.

Throws:

StandardException