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

pack-priv Class UnaryOperatorNode

extends OperatorNode
Class Inheritance
Known Direct Subclasses
org.apache.derby.impl.sql.compile.WindowFunctionNode, org.apache.derby.impl.sql.compile.AggregateNode, org.apache.derby.impl.sql.compile.DB2LengthOperatorNode, org.apache.derby.impl.sql.compile.ExtractOperatorNode, org.apache.derby.impl.sql.compile.LengthOperatorNode, org.apache.derby.impl.sql.compile.SimpleStringOperatorNode, org.apache.derby.impl.sql.compile.UnaryArithmeticOperatorNode, org.apache.derby.impl.sql.compile.UnaryComparisonOperatorNode, org.apache.derby.impl.sql.compile.UnaryDateTimestampOperatorNode, org.apache.derby.impl.sql.compile.UnaryLogicalOperatorNode
Imports
java.lang.reflect.Modifier, java.sql.Types, java.util.List, org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.reference.ClassName, .SQLState, org.apache.derby.iapi.services.classfile.VMOpcode, org.apache.derby.iapi.services.compiler.LocalField, .MethodBuilder, org.apache.derby.iapi.services.context.ContextManager, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.compile.Visitor, org.apache.derby.iapi.store.access.Qualifier, org.apache.derby.iapi.types.DataTypeDescriptor, .TypeId, org.apache.derby.iapi.util.JBitSet

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

Modifier and TypeField and Description
pack-priv static final int
pack-priv static final int
pack-priv static final int
pack-priv final int
kind

This class is used to hold logically different objects for space efficiency.

pack-priv String
pack-priv ValueNode
operand

Warning

operand may be NULL for COUNT(*).

pack-priv String
private boolean
preserveWhitespace

Whether or not an XMLParse operator should preserve whitespace.

pack-priv String
pack-priv String
private DataTypeDescriptor
targetType

Target type for XMLSerialize operator.

pack-priv static final String[]
pack-priv static final String[]
pack-priv static final String[]
pack-priv static final String[]

Constructor Summary

AccessConstructor and Description
pack-priv
UnaryOperatorNode(ValueNode operand, String operator, String methodNameOrAddedArgs, ContextManager cm)

When UnaryOperatorNode is used as an base class, this constructor is used as super.

pack-priv
UnaryOperatorNode(ValueNode operand, ContextManager cm)

When UnaryOperatorNode is used as an base class, this constructor is used as super.

pack-priv
UnaryOperatorNode(ValueNode
The operand of the node
operand
,
int
The kind of operator
kind
,
DataTypeDescriptor
The DTD of the target type
targetType
,
boolean
true if white space is to be preserved (relevant for kind == XMLPARSE only)
preserveWhiteSpace
,
ContextManager
The context manager
cm
)

Constructor for a UnaryOperatorNode when used as a concrete class.

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 int

Returns:

Number of parameters added.
addXmlOpMethodParams
(ExpressionClassBuilder
the builder for the class in which the method lives
acb
,
MethodBuilder
The MethodBuilder that will make the call.
mb
,
LocalField
the field that contains the previous result
resultField
)

Add some additional arguments to our method call for XML related operations like XMLPARSE and XMLSERIALIZE.

pack-priv ValueNode

Returns:

The new top of the expression tree.
bindExpression
(FromList
The FROM list for the query this expression is in, for binding columns.
fromList
,
SubqueryList
The subquery list being built as we find SubqueryNodes
subqueryList
,
List<AggregateNode>
The aggregate list being built as we find AggregateNodes
aggregates
)

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

Bind this expression.

protected void
bindOperand(FromList fromList, SubqueryList subqueryList, List<AggregateNode> aggregates)

Bind the operand for this unary operator.

pack-priv void
bindParameter()

By default unary operators don't accept ?

private void
bindXMLParse()

Bind an XMLPARSE operator.

private void
bindXMLSerialize()

Bind an XMLSERIALIZE operator.

pack-priv boolean

Returns:

boolean Whether or not source.expression is a ColumnReference or a VirtualColumnNode.
categorize
(JBitSet
JBitSet with bit map of referenced FromTables
referencedTabs
,
boolean
Whether or not to consider method calls, field references and conditional nodes when building bit map
simplePredsOnly
)

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

Categorize this predicate.

pack-priv boolean
constantExpression(PredicateList whereClause)

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

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

pack-priv void
generateExpression(ExpressionClassBuilder
The ExpressionClassBuilder for the class we're generating
acb
,
MethodBuilder
The method the expression will go into
mb
)

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

Do code generation for this unary operator.

pack-priv ValueNode

Returns:

The operand of this unary operator.
getOperand
()

Get the operand of this unary operator.

pack-priv String

Returns:

The operator of this unary operator.
getOperatorString
()

Get the operator of this unary operator.

protected int

Returns:

The variant type for the underlying expression.
getOrderableVariantType
()

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

Return the variant type for the underlying expression.

pack-priv ParameterNode

Returns:

The parameter operand of this unary operator else null.
getParameterOperand
()

Get the parameter operand of this unary operator.

pack-priv String
getReceiverInterfaceName()

Determine the type the binary method is called on.

pack-priv boolean

Returns:

Whether or not this expression tree represents a constant expression.
isConstantExpression
()

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

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

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

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

Tests if this node is equivalent to the specified ValueNode.

pack-priv boolean
isSameNodeKind(ValueNode
The other value node whose kind we want to compare with.
o
)

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

Some node classes represent several logical node types (to reduce footprint), which we call kinds.

pack-priv ValueNode

Returns:

The modified expression
preprocess
(int
Number of tables in the DML Statement
numTables
,
FromList
FromList from outer query block
outerFromList
,
SubqueryList
SubqueryList from outer query block
outerSubqueryList
,
PredicateList
PredicateList from outer query block
outerPredicateList
)

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

Preprocess an expression tree.

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 ValueNode

Returns:

ValueNode The remapped expression tree.
remapColumnReferencesToExpressions
()

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

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

pack-priv void
setMethodName(String
The methodName.
methodName
)

Set the methodName.

pack-priv void
setOperator(String
The operator.
operator
)

Set the operator.

public String

Returns:

This object as a 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.OperatorNode:
pushSqlXmlUtil

Field Detail

K_BASEback to summary
pack-priv static final int K_BASE
K_XMLPARSEback to summary
pack-priv static final int K_XMLPARSE
K_XMLSERIALIZEback to summary
pack-priv static final int K_XMLSERIALIZE
kindback to summary
pack-priv final int kind

This class is used to hold logically different objects for space efficiency. kind represents the logical object type. See also ValueNode#isSameNodeKind.

methodNameback to summary
pack-priv String methodName
operandback to summary
pack-priv ValueNode operand

Warning

operand may be NULL for COUNT(*).

operatorback to summary
pack-priv String operator
preserveWhitespaceback to summary
private boolean preserveWhitespace

Whether or not an XMLParse operator should preserve whitespace.

receiverInterfaceTypeback to summary
pack-priv String receiverInterfaceType
resultInterfaceTypeback to summary
pack-priv String resultInterfaceType
targetTypeback to summary
private DataTypeDescriptor targetType

Target type for XMLSerialize operator.

UnaryArgTypesback to summary
pack-priv static final String[] UnaryArgTypes
UnaryMethodNamesback to summary
pack-priv static final String[] UnaryMethodNames
UnaryOperatorsback to summary
pack-priv static final String[] UnaryOperators
UnaryResultTypesback to summary
pack-priv static final String[] UnaryResultTypes

Constructor Detail

UnaryOperatorNodeback to summary
pack-priv UnaryOperatorNode(ValueNode operand, String operator, String methodNameOrAddedArgs, ContextManager cm) throws StandardException

When UnaryOperatorNode is used as an base class, this constructor is used as super.

UnaryOperatorNodeback to summary
pack-priv UnaryOperatorNode(ValueNode operand, ContextManager cm)

When UnaryOperatorNode is used as an base class, this constructor is used as super.

UnaryOperatorNodeback to summary
pack-priv UnaryOperatorNode(ValueNode operand, int kind, DataTypeDescriptor targetType, boolean preserveWhiteSpace, ContextManager cm)

Constructor for a UnaryOperatorNode when used as a concrete class.

Parameters
operand:ValueNode

The operand of the node

kind:int

The kind of operator

targetType:DataTypeDescriptor

The DTD of the target type

preserveWhiteSpace:boolean

true if white space is to be preserved (relevant for kind == XMLPARSE only)

cm:ContextManager

The context manager

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
addXmlOpMethodParamsback to summary
pack-priv 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:ExpressionClassBuilder

the builder for the class in which the method lives

mb:MethodBuilder

The MethodBuilder that will make the call.

resultField:LocalField

the field that contains the previous result

Returns:int

Number of parameters added.

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.

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.

Parameters
fromList:FromList

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

subqueryList:SubqueryList

The subquery list being built as we find SubqueryNodes

aggregates:List<AggregateNode>

The aggregate list being built as we find AggregateNodes

Returns:ValueNode

The new top of the expression tree.

Annotations
@Override
Exceptions
StandardException:
Thrown on error
bindOperandback to summary
protected void bindOperand(FromList fromList, SubqueryList subqueryList, 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.

bindParameterback to summary
pack-priv 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.

Exceptions
StandardException:
Thrown if ? parameter doesn't have a type bound to it yet. ? parameter where it isn't allowed.
bindXMLParseback to summary
private void bindXMLParse() throws StandardException

Bind an XMLPARSE operator. Makes sure the operand type is correct, and sets the result type.

Exceptions
StandardException:
Thrown on error
bindXMLSerializeback to summary
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.

Exceptions
StandardException:
Thrown on error
categorizeback to summary
pack-priv boolean categorize(JBitSet referencedTabs, boolean simplePredsOnly) throws StandardException

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

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

JBitSet with bit map of referenced FromTables

simplePredsOnly:boolean

Whether or not to consider method calls, field references and conditional nodes when building bit map

Returns:boolean

boolean Whether or not source.expression is a ColumnReference or a VirtualColumnNode.

Annotations
@Override
Exceptions
StandardException:
Thrown on error
constantExpressionback to summary
pack-priv boolean constantExpression(PredicateList whereClause)

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

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

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.

Returns:boolean

True means this expression tree represents a constant value.

Annotations
@Override
See Also
ValueNode#constantExpression
generateExpressionback to summary
pack-priv void generateExpression(ExpressionClassBuilder acb, MethodBuilder mb) throws StandardException

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

Do code generation for this unary operator.

Parameters
acb:ExpressionClassBuilder

The ExpressionClassBuilder for the class we're generating

mb:MethodBuilder

The method the expression will go into

Annotations
@Override
Exceptions
StandardException:
Thrown on error
getOperandback to summary
pack-priv ValueNode getOperand()

Get the operand of this unary operator.

Returns:ValueNode

The operand of this unary operator.

getOperatorStringback to summary
pack-priv String getOperatorString()

Get the operator of this unary operator.

Returns:String

The operator of this unary operator.

getOrderableVariantTypeback to summary
protected int getOrderableVariantType() throws StandardException

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

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

Returns:int

The variant type for the underlying expression.

Annotations
@Override
Exceptions
StandardException:
thrown on error
getParameterOperandback to summary
pack-priv 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:ParameterNode

The parameter operand of this unary operator else null.

getReceiverInterfaceNameback to summary
pack-priv 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.

Exceptions
StandardException:
Thrown on error
isConstantExpressionback to summary
pack-priv boolean isConstantExpression()

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

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

Returns:boolean

Whether or not this expression tree represents a constant expression.

Annotations
@Override
isEquivalentback to summary
pack-priv boolean isEquivalent(ValueNode o) 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
o:ValueNode

the node to compare this ValueNode against.

Returns:boolean

true if the two nodes are equivalent, false otherwise.

Exceptions
StandardException
isSameNodeKindback to summary
pack-priv boolean isSameNodeKind(ValueNode o)

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

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

Some node classes represent several logical node types (to reduce footprint), which we call kinds. This means that implementations of isEquivalent cannot always just use instanceof 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 of isEquivalent.

Parameters
o:ValueNode

The other value node whose kind we want to compare with.

Returns:boolean

true if this and o represent the same logical node type, i.e. kind.

Annotations
@Override
preprocessback to summary
pack-priv ValueNode preprocess(int numTables, FromList outerFromList, SubqueryList outerSubqueryList, PredicateList outerPredicateList) throws StandardException

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

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.

Parameters
numTables:int

Number of tables in the DML Statement

outerFromList:FromList

FromList from outer query block

outerSubqueryList:SubqueryList

SubqueryList from outer query block

outerPredicateList:PredicateList

PredicateList from outer query block

Returns:ValueNode

The modified expression

Annotations
@Override
Exceptions
StandardException:
Thrown on error
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
remapColumnReferencesToExpressionsback to summary
pack-priv ValueNode remapColumnReferencesToExpressions() throws StandardException

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

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

Returns:ValueNode

ValueNode The remapped expression tree.

Annotations
@Override
Exceptions
StandardException:
Thrown on error
setMethodNameback to summary
pack-priv void setMethodName(String methodName)

Set the methodName.

Parameters
methodName:String

The methodName.

setOperatorback to summary
pack-priv void setOperator(String operator)

Set the operator.

Parameters
operator:String

The operator.

toStringback to summary
public String toString()

Overrides 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