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

pack-priv Class TernaryOperatorNode

extends OperatorNode
Class Inheritance
Known Direct Subclasses
org.apache.derby.impl.sql.compile.LikeEscapeOperatorNode
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.iapi.services.io.StoredFormatIds, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.compile.TypeCompiler, .Visitor, org.apache.derby.iapi.types.DataTypeDescriptor, .TypeId, org.apache.derby.iapi.util.JBitSet

A TernaryOperatorNode represents a built-in ternary operators. This covers built-in functions like substr(). 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 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
pack-priv String
pack-priv String
pack-priv ValueNode
pack-priv String
pack-priv String
pack-priv String
pack-priv ValueNode
pack-priv static final String[][]
pack-priv static final String[]
pack-priv static final String[]
pack-priv static final String[]
pack-priv int

Constructor Summary

AccessConstructor and Description
pack-priv
TernaryOperatorNode(ValueNode
The receiver (e.g., string being operated on in substr())
receiver
,
ValueNode
The left operand of the node
leftOperand
,
ValueNode
The right operand of the node
rightOperand
,
int
The kind of the operand
kind
,
ContextManager
The context manager
cm
)

Constructor for a TernaryOperatorNode

pack-priv
TernaryOperatorNode(ValueNode
The receiver (e.g., string being operated on in substr())
receiver
,
ValueNode
The left operand of the node
leftOperand
,
ValueNode
The right operand of the node
rightOperand
,
int
The kind of the operand
kind
,
int
The trim type
trimType
,
ContextManager
The context manager
cm
)

Constructor for a TernaryOperatorNode

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.

private void
bindDateTimeArg(ValueNode arg, int argNumber)

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.

private boolean

Returns:

true if arg is a ? param with no type associated with it
bindParameter
(ValueNode
Check if arg is a ? param and if yes, then set it's type to jdbcType if arg doesn't have a type associated with it.
arg
,
int
Associate this type with arg if arg is a ? param with no type associated with it
jdbcType
)

This method gets called for non-character string types and hence no need to set any collation info.

protected void
protected ValueNode
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.

private void
constructorMinion(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int trimType)

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 ternary operator.

pack-priv ValueNode

Returns:

The current leftOperand.
getLeftOperand
()

Get the leftOperand

pack-priv ValueNode
pack-priv ValueNode

Returns:

The current rightOperand.
getRightOperand
()

Get the rightOperand

private DataTypeDescriptor
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 new top of the expression tree.
locateBind
()

Bind locate operator The variable receiver is the string which will searched The variable leftOperand is the search character that will looked in the receiver variable.

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
setLeftOperand(ValueNode
The new leftOperand
newLeftOperand
)

Set the leftOperand to the specified ValueNode

private void
setResultType(TypeId resultType)

pack-priv void
setRightOperand(ValueNode
The new rightOperand
newRightOperand
)

Set the rightOperand to the specified ValueNode

pack-priv ValueNode

Returns:

The new top of the expression tree.
substrBind
()

Bind substr expression.

private void
throwBadType(String funcName, String type)

private ValueNode

Returns:

The new top of the expression tree.
timestampAddBind
()

Bind TIMESTAMPADD expression.

private ValueNode

Returns:

The new top of the expression tree.
timestampDiffBind
()

Bind TIMESTAMPDIFF expression.

public String

Returns:

This object as a String
toString
()

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

Convert this object to a String.

private ValueNode

Returns:

The new top of the expression tree.
trimBind
()

Bind trim expression.

Inherited from org.apache.derby.impl.sql.compile.OperatorNode:
pushSqlXmlUtil

Field Detail

K_LIKEback to summary
pack-priv static final int K_LIKE
K_LOCATEback to summary
pack-priv static final int K_LOCATE
K_SUBSTRINGback to summary
pack-priv static final int K_SUBSTRING
K_TIMESTAMPADDback to summary
pack-priv static final int K_TIMESTAMPADD
K_TIMESTAMPDIFFback to summary
pack-priv static final int K_TIMESTAMPDIFF
K_TRIMback to summary
pack-priv static final int K_TRIM
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.

leftInterfaceTypeback to summary
pack-priv String leftInterfaceType
leftOperandback to summary
pack-priv ValueNode leftOperand
methodNameback to summary
pack-priv String methodName
operatorback to summary
pack-priv String operator
receiverback to summary
pack-priv ValueNode receiver
receiverInterfaceTypeback to summary
pack-priv String receiverInterfaceType
resultInterfaceTypeback to summary
pack-priv String resultInterfaceType
rightInterfaceTypeback to summary
pack-priv String rightInterfaceType
rightOperandback to summary
pack-priv ValueNode rightOperand
TernaryArgTypeback to summary
pack-priv static final String[][] TernaryArgType
TernaryMethodNamesback to summary
pack-priv static final String[] TernaryMethodNames
TernaryOperatorsback to summary
pack-priv static final String[] TernaryOperators
TernaryResultTypeback to summary
pack-priv static final String[] TernaryResultType
trimTypeback to summary
pack-priv int trimType

Constructor Detail

TernaryOperatorNodeback to summary
pack-priv TernaryOperatorNode(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int kind, ContextManager cm)

Constructor for a TernaryOperatorNode

Parameters
receiver:ValueNode

The receiver (e.g., string being operated on in substr())

leftOperand:ValueNode

The left operand of the node

rightOperand:ValueNode

The right operand of the node

kind:int

The kind of the operand

cm:ContextManager

The context manager

TernaryOperatorNodeback to summary
pack-priv TernaryOperatorNode(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int kind, int trimType, ContextManager cm)

Constructor for a TernaryOperatorNode

Parameters
receiver:ValueNode

The receiver (e.g., string being operated on in substr())

leftOperand:ValueNode

The left operand of the node

rightOperand:ValueNode

The right operand of the node

kind:int

The kind of the operand

trimType:int

The trim type

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
bindDateTimeArgback to summary
private void bindDateTimeArg(ValueNode arg, int argNumber) throws StandardException
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.

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
bindParameterback to summary
private boolean bindParameter(ValueNode arg, int jdbcType) throws StandardException

This method gets called for non-character string types and hence no need to set any collation info. Collation applies only to character string types.

Parameters
arg:ValueNode

Check if arg is a ? param and if yes, then set it's type to jdbcType if arg doesn't have a type associated with it.

jdbcType:int

Associate this type with arg if arg is a ? param with no type associated with it

Returns:boolean

true if arg is a ? param with no type associated with it

bindToBuiltInback to summary
protected void bindToBuiltIn() throws StandardException
castArgToStringback to summary
protected ValueNode castArgToString(ValueNode vn) throws StandardException
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
constructorMinionback to summary
private void constructorMinion(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int trimType)
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 ternary 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
getLeftOperandback to summary
pack-priv ValueNode getLeftOperand()

Get the leftOperand

Returns:ValueNode

The current leftOperand.

getReceiverback to summary
pack-priv ValueNode getReceiver()
getRightOperandback to summary
pack-priv ValueNode getRightOperand()

Get the rightOperand

Returns:ValueNode

The current rightOperand.

getVarcharDescriptorback to summary
private DataTypeDescriptor getVarcharDescriptor()
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.

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.

locateBindback to summary
pack-priv ValueNode locateBind() throws StandardException

Bind locate operator The variable receiver is the string which will searched The variable leftOperand is the search character that will looked in the receiver variable.

Returns:ValueNode

The new top of the expression tree.

Exceptions
StandardException:
Thrown on error
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
setLeftOperandback to summary
pack-priv void setLeftOperand(ValueNode newLeftOperand)

Set the leftOperand to the specified ValueNode

Parameters
newLeftOperand:ValueNode

The new leftOperand

setResultTypeback to summary
private void setResultType(TypeId resultType) throws StandardException
setRightOperandback to summary
pack-priv void setRightOperand(ValueNode newRightOperand)

Set the rightOperand to the specified ValueNode

Parameters
newRightOperand:ValueNode

The new rightOperand

substrBindback to summary
pack-priv ValueNode substrBind() throws StandardException

Bind substr expression.

Returns:ValueNode

The new top of the expression tree.

Exceptions
StandardException:
Thrown on error
throwBadTypeback to summary
private void throwBadType(String funcName, String type) throws StandardException
timestampAddBindback to summary
private ValueNode timestampAddBind() throws StandardException

Bind TIMESTAMPADD expression.

Returns:ValueNode

The new top of the expression tree.

Exceptions
StandardException:
Thrown on error
timestampDiffBindback to summary
private ValueNode timestampDiffBind() throws StandardException

Bind TIMESTAMPDIFF expression.

Returns:ValueNode

The new top of the expression tree.

Exceptions
StandardException:
Thrown on error
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
trimBindback to summary
private ValueNode trimBind() throws StandardException

Bind trim expression. The variable receiver is the string that needs to be trimmed. The variable leftOperand is the character that needs to be trimmed from receiver.

Returns:ValueNode

The new top of the expression tree.

Exceptions
StandardException:
Thrown on error