Class UnaryOperatorNode
- 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.UnaryOperatorNode
-
- All Implemented Interfaces:
Visitable
- Direct Known Subclasses:
AggregateNode
,DB2LengthOperatorNode
,ExtractOperatorNode
,LengthOperatorNode
,SimpleStringOperatorNode
,UnaryArithmeticOperatorNode
,UnaryComparisonOperatorNode
,UnaryDateTimestampOperatorNode
,UnaryLogicalOperatorNode
,WindowFunctionNode
class UnaryOperatorNode extends OperatorNode
A UnaryOperatorNode represents a built-in unary operator as defined by the ANSI/ISO SQL standard. This covers operators like +, -, NOT, and IS NULL. 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 Description (package private) static int
K_BASE
(package private) static int
K_XMLPARSE
(package private) static int
K_XMLSERIALIZE
(package private) int
kind
This class is used to hold logically different objects for space efficiency.(package private) java.lang.String
methodName
(package private) ValueNode
operand
WARNING: operand may be NULL for COUNT(*).(package private) java.lang.String
operator
private boolean
preserveWhitespace
Whether or not an XMLParse operator should preserve whitespace.(package private) java.lang.String
receiverInterfaceType
(package private) java.lang.String
resultInterfaceType
private DataTypeDescriptor
targetType
Target type for XMLSerialize operator.(package private) static java.lang.String[]
UnaryArgTypes
(package private) static java.lang.String[]
UnaryMethodNames
(package private) static java.lang.String[]
UnaryOperators
(package private) static java.lang.String[]
UnaryResultTypes
-
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_CYCLE, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX
-
-
Constructor Summary
Constructors Constructor Description UnaryOperatorNode(ValueNode operand, int kind, DataTypeDescriptor targetType, boolean preserveWhiteSpace, ContextManager cm)
Constructor for a UnaryOperatorNode when used as a concrete class.UnaryOperatorNode(ValueNode operand, java.lang.String operator, java.lang.String methodNameOrAddedArgs, ContextManager cm)
When UnaryOperatorNode is used as an base class, this constructor is used assuper
.UnaryOperatorNode(ValueNode operand, ContextManager cm)
When UnaryOperatorNode is used as an base class, this constructor is used assuper
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
acceptChildren(Visitor v)
Accept the visitor for all visitable children of this node.(package private) int
addXmlOpMethodParams(ExpressionClassBuilder acb, MethodBuilder mb, LocalField resultField)
Add some additional arguments to our method call for XML related operations like XMLPARSE and XMLSERIALIZE.(package private) ValueNode
bindExpression(FromList fromList, SubqueryList subqueryList, java.util.List<AggregateNode> aggregates)
Bind this expression.protected void
bindOperand(FromList fromList, SubqueryList subqueryList, java.util.List<AggregateNode> aggregates)
Bind the operand for this unary operator.(package private) void
bindParameter()
By default unary operators don't accept ?private void
bindXMLParse()
Bind an XMLPARSE operator.private void
bindXMLSerialize()
Bind an XMLSERIALIZE operator.(package private) boolean
categorize(JBitSet referencedTabs, boolean simplePredsOnly)
Categorize this predicate.(package private) boolean
constantExpression(PredicateList whereClause)
Return whether or not this expression tree represents a constant value.(package private) void
generateExpression(ExpressionClassBuilder acb, MethodBuilder mb)
Do code generation for this unary operator.(package private) ValueNode
getOperand()
Get the operand of this unary operator.(package private) java.lang.String
getOperatorString()
Get the operator of this unary operator.protected int
getOrderableVariantType()
Return the variant type for the underlying expression.(package private) ParameterNode
getParameterOperand()
Get the parameter operand of this unary operator.(package private) java.lang.String
getReceiverInterfaceName()
Determine the type the binary method is called on.(package private) boolean
isConstantExpression()
Return whether or not this expression tree represents a constant expression.(package private) boolean
isEquivalent(ValueNode o)
Tests if this node is equivalent to the specified ValueNode.(package private) boolean
isSameNodeKind(ValueNode o)
Some node classes represent several logical node types (to reduce footprint), which we call kinds.(package private) ValueNode
preprocess(int numTables, FromList outerFromList, SubqueryList outerSubqueryList, PredicateList outerPredicateList)
Preprocess an expression tree.(package private) void
printSubNodes(int depth)
Prints the sub-nodes of this object.(package private) ValueNode
remapColumnReferencesToExpressions()
Remap all ColumnReferences in this tree to be clones of the underlying expression.(package private) void
setMethodName(java.lang.String methodName)
Set the methodName.(package private) void
setOperator(java.lang.String operator)
Set the operator.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, genIsNullTree, genSQLJavaSQLTree, getClone, getColumnName, getConstantValueAsObject, getDataValueFactory, getSchemaName, getSourceResultColumn, getTableName, getTablesReferenced, getTransformed, getTypeCompiler, getTypeId, getTypeServices, isBinaryEqualsOperatorNode, isBooleanFalse, isBooleanTrue, isCloneable, isInListProbeNode, isParameterNode, isRelationalOperator, 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, 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, referencesSessionSchema, resolveTableToSynonym, setBeginOffset, setEndOffset, setRefActionInfo, stackPrint, taggedWith, treePrint, treePrint, verifyClassExist
-
-
-
-
Field Detail
-
operator
java.lang.String operator
-
methodName
java.lang.String methodName
-
resultInterfaceType
java.lang.String resultInterfaceType
-
receiverInterfaceType
java.lang.String receiverInterfaceType
-
operand
ValueNode operand
WARNING: operand may be NULL for COUNT(*).
-
K_XMLPARSE
static final int K_XMLPARSE
- See Also:
- Constant Field Values
-
K_XMLSERIALIZE
static final int K_XMLSERIALIZE
- See Also:
- Constant Field Values
-
K_BASE
static final int K_BASE
- See Also:
- Constant Field Values
-
kind
final int kind
This class is used to hold logically different objects for space efficiency.kind
represents the logical object type. See alsoValueNode.isSameNodeKind(org.apache.derby.impl.sql.compile.ValueNode)
.
-
UnaryOperators
static final java.lang.String[] UnaryOperators
-
UnaryMethodNames
static final java.lang.String[] UnaryMethodNames
-
UnaryResultTypes
static final java.lang.String[] UnaryResultTypes
-
UnaryArgTypes
static final java.lang.String[] UnaryArgTypes
-
targetType
private DataTypeDescriptor targetType
Target type for XMLSerialize operator.
-
preserveWhitespace
private boolean preserveWhitespace
Whether or not an XMLParse operator should preserve whitespace.
-
-
Constructor Detail
-
UnaryOperatorNode
UnaryOperatorNode(ValueNode operand, java.lang.String operator, java.lang.String methodNameOrAddedArgs, ContextManager cm) throws StandardException
When UnaryOperatorNode is used as an base class, this constructor is used assuper
.- Throws:
StandardException
-
UnaryOperatorNode
UnaryOperatorNode(ValueNode operand, ContextManager cm)
When UnaryOperatorNode is used as an base class, this constructor is used assuper
.
-
UnaryOperatorNode
UnaryOperatorNode(ValueNode operand, int kind, DataTypeDescriptor targetType, boolean preserveWhiteSpace, ContextManager cm)
Constructor for a UnaryOperatorNode when used as a concrete class.- Parameters:
operand
- The operand of the nodekind
- The kind of operatortargetType
- The DTD of the target typepreserveWhiteSpace
-true
if white space is to be preserved (relevant for kind == XMLPARSE only)cm
- The context manager
-
-
Method Detail
-
setOperator
void setOperator(java.lang.String operator)
Set the operator.- Parameters:
operator
- The operator.
-
getOperatorString
java.lang.String getOperatorString()
Get the operator of this unary operator.- Returns:
- The operator of this unary operator.
-
setMethodName
void setMethodName(java.lang.String methodName)
Set the methodName.- Parameters:
methodName
- The methodName.
-
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.
-
printSubNodes
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 classQueryTreeNode
- Parameters:
depth
- The depth of this node in the tree
-
getOperand
ValueNode getOperand()
Get the operand of this unary operator.- Returns:
- The operand of this unary operator.
-
getParameterOperand
ParameterNode getParameterOperand() throws StandardException
Get the parameter operand of this unary operator. For the example below, for abs unary operator node, we want to get ? select * from t1 where -? = max_cni(abs(-?), sqrt(+?)) This gets called when ParameterNode is needed to get parameter specific information like getDefaultValue(), getParameterNumber() etc- Returns:
- The parameter operand of this unary operator else null.
- Throws:
StandardException
-
bindExpression
ValueNode bindExpression(FromList fromList, SubqueryList subqueryList, java.util.List<AggregateNode> aggregates) throws StandardException
Bind this expression. This means binding the sub-expressions, as well as figuring out what the return type is for this expression. This method is the implementation for XMLPARSE and XMLSERIALIZE. Sub-classes need to implement their own bindExpression() method for their own specific rules.- Overrides:
bindExpression
in classValueNode
- Parameters:
fromList
- The FROM list for the query this expression is in, for binding columns.subqueryList
- The subquery list being built as we find SubqueryNodesaggregates
- The aggregate list being built as we find AggregateNodes- Returns:
- The new top of the expression tree.
- Throws:
StandardException
- Thrown on error
-
bindOperand
protected void bindOperand(FromList fromList, SubqueryList subqueryList, java.util.List<AggregateNode> aggregates) throws StandardException
Bind the operand for this unary operator. Binding the operator may change the operand node. Sub-classes bindExpression() methods need to call this method to bind the operand.- Throws:
StandardException
-
bindXMLParse
private void bindXMLParse() throws StandardException
Bind an XMLPARSE operator. Makes sure the operand type is correct, and sets the result type.- Throws:
StandardException
- Thrown on error
-
bindXMLSerialize
private void bindXMLSerialize() throws StandardException
Bind an XMLSERIALIZE operator. Makes sure the operand type and target type are both correct, and sets the result type.- Throws:
StandardException
- Thrown on error
-
preprocess
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 classValueNode
- Parameters:
numTables
- Number of tables in the DML StatementouterFromList
- FromList from outer query blockouterSubqueryList
- SubqueryList from outer query blockouterPredicateList
- PredicateList from outer query block- Returns:
- The modified expression
- Throws:
StandardException
- Thrown on error
-
categorize
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 classValueNode
- Parameters:
referencedTabs
- JBitSet with bit map of referenced FromTablessimplePredsOnly
- 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
ValueNode remapColumnReferencesToExpressions() throws StandardException
Remap all ColumnReferences in this tree to be clones of the underlying expression.- Overrides:
remapColumnReferencesToExpressions
in classValueNode
- Returns:
- ValueNode The remapped expression tree.
- Throws:
StandardException
- Thrown on error
-
isConstantExpression
boolean isConstantExpression()
Return whether or not this expression tree represents a constant expression.- Overrides:
isConstantExpression
in classValueNode
- Returns:
- Whether or not this expression tree represents a constant expression.
-
constantExpression
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 classValueNode
- Returns:
- True means this expression tree represents a constant value.
- See Also:
ValueNode.constantExpression(org.apache.derby.impl.sql.compile.PredicateList)
-
bindParameter
void bindParameter() throws StandardException
By default unary operators don't accept ? parameters as operands. This can be over-ridden for particular unary operators. We throw an exception if the parameter doesn't have a datatype assigned to it yet.- Throws:
StandardException
- Thrown if ? parameter doesn't have a type bound to it yet. ? parameter where it isn't allowed.
-
generateExpression
void generateExpression(ExpressionClassBuilder acb, MethodBuilder mb) throws StandardException
Do code generation for this unary operator.- Overrides:
generateExpression
in classValueNode
- Parameters:
acb
- The ExpressionClassBuilder for the class we're generatingmb
- The method the expression will go into- Throws:
StandardException
- Thrown on error
-
getReceiverInterfaceName
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 expressions) CONSTANT - immutable- Overrides:
getOrderableVariantType
in classValueNode
- 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 classQueryTreeNode
- Parameters:
v
- the visitor- Throws:
StandardException
- on error
-
addXmlOpMethodParams
int addXmlOpMethodParams(ExpressionClassBuilder acb, MethodBuilder mb, LocalField resultField) throws StandardException
Add some additional arguments to our method call for XML related operations like XMLPARSE and XMLSERIALIZE.- Parameters:
acb
- the builder for the class in which the method livesmb
- The MethodBuilder that will make the call.resultField
- the field that contains the previous result- Returns:
- Number of parameters added.
- Throws:
StandardException
-
isEquivalent
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 classValueNode
- Parameters:
o
- the node to compare this ValueNode against.- Returns:
true
if the two nodes are equivalent,false
otherwise.- Throws:
StandardException
-
isSameNodeKind
boolean isSameNodeKind(ValueNode o)
Description copied from class:ValueNode
Some node classes represent several logical node types (to reduce footprint), which we call kinds. This means that implementations ofValueNode.isEquivalent(org.apache.derby.impl.sql.compile.ValueNode)
cannot always just useinstanceof
to check if the other node represents the same kind. Hence this method needs to be overridden by all node classes that represent several kinds. This default implementation does not look at kinds. It is only called from implementations ofisEquivalent
.- Overrides:
isSameNodeKind
in classValueNode
- Parameters:
o
- The other value node whose kind we want to compare with.- Returns:
true
ifthis
ando
represent the same logical node type, i.e. kind.
-
-