TernaryOperatorNode (Apache Derby V10.14 Internals)

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.TernaryOperatorNode

All Implemented Interfaces:

Visitable

Direct Known Subclasses:

LikeEscapeOperatorNode
```
class TernaryOperatorNode
extends OperatorNode
```
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

Fields
Modifier and Type	Field	Description
`(package private) static int`	`K_LIKE`
`(package private) static int`	`K_LOCATE`
`(package private) static int`	`K_SUBSTRING`
`(package private) static int`	`K_TIMESTAMPADD`
`(package private) static int`	`K_TIMESTAMPDIFF`
`(package private) static int`	`K_TRIM`
`(package private) int`	`kind`	This class is used to hold logically different objects for space efficiency.
`(package private) java.lang.String`	`leftInterfaceType`
`(package private) ValueNode`	`leftOperand`
`(package private) java.lang.String`	`methodName`
`(package private) java.lang.String`	`operator`
`(package private) ValueNode`	`receiver`
`(package private) java.lang.String`	`receiverInterfaceType`
`(package private) java.lang.String`	`resultInterfaceType`
`(package private) java.lang.String`	`rightInterfaceType`
`(package private) ValueNode`	`rightOperand`
`(package private) static java.lang.String[][]`	`TernaryArgType`
`(package private) static java.lang.String[]`	`TernaryMethodNames`
`(package private) static java.lang.String[]`	`TernaryOperators`
`(package private) static java.lang.String[]`	`TernaryResultType`
`(package private) int`	`trimType`

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

Fields inherited from class org.apache.derby.impl.sql.compile.ValueNode
transformed

Constructor Summary

Constructors
Constructor	Description
`TernaryOperatorNode(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int kind, int trimType, ContextManager cm)`	Constructor for a TernaryOperatorNode
`TernaryOperatorNode(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int kind, ContextManager cm)`	Constructor for a TernaryOperatorNode

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.
`private void`	`bindDateTimeArg(ValueNode arg, int argNumber)`
`(package private) ValueNode`	`bindExpression(FromList fromList, SubqueryList subqueryList, java.util.List<AggregateNode> aggregates)`	Bind this expression.
`private boolean`	`bindParameter(ValueNode arg, int jdbcType)`	This method gets called for non-character string types and hence no need to set any collation info.
`protected void`	`bindToBuiltIn()`
`protected ValueNode`	`castArgToString(ValueNode vn)`
`(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.
`private void`	`constructorMinion(ValueNode receiver, ValueNode leftOperand, ValueNode rightOperand, int trimType)`
`(package private) void`	`generateExpression(ExpressionClassBuilder acb, MethodBuilder mb)`	Do code generation for this ternary operator.
`(package private) ValueNode`	`getLeftOperand()`	Get the leftOperand
`(package private) ValueNode`	`getReceiver()`
`(package private) ValueNode`	`getRightOperand()`	Get the rightOperand
`private DataTypeDescriptor`	`getVarcharDescriptor()`
`(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`	`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.
`(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`	`setLeftOperand(ValueNode newLeftOperand)`	Set the leftOperand to the specified ValueNode
`private void`	`setResultType(TypeId resultType)`
`(package private) void`	`setRightOperand(ValueNode newRightOperand)`	Set the rightOperand to the specified ValueNode
`(package private) ValueNode`	`substrBind()`	Bind substr expression.
`private void`	`throwBadType(java.lang.String funcName, java.lang.String type)`
`private ValueNode`	`timestampAddBind()`	Bind TIMESTAMPADD expression.
`private ValueNode`	`timestampDiffBind()`	Bind TIMESTAMPDIFF expression.
`java.lang.String`	`toString()`	Convert this object to a String.
`private ValueNode`	`trimBind()`	Bind trim expression.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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, getOrderableVariantType, 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

- Field Detail
  - K_TRIM
```
static final int K_TRIM
```
    See Also:
    
    Constant Field Values
  - K_LOCATE
```
static final int K_LOCATE
```
    See Also:
    
    Constant Field Values
  - K_SUBSTRING
```
static final int K_SUBSTRING
```
    See Also:
    
    Constant Field Values
  - K_LIKE
```
static final int K_LIKE
```
    See Also:
    
    Constant Field Values
  - K_TIMESTAMPADD
```
static final int K_TIMESTAMPADD
```
    See Also:
    
    Constant Field Values
  - K_TIMESTAMPDIFF
```
static final int K_TIMESTAMPDIFF
```
    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 also ValueNode.isSameNodeKind(org.apache.derby.impl.sql.compile.ValueNode).
  - operator
```
java.lang.String operator
```
  - methodName
```
java.lang.String methodName
```
  - receiver
```
ValueNode receiver
```
  - leftOperand
```
ValueNode leftOperand
```
  - rightOperand
```
ValueNode rightOperand
```
  - resultInterfaceType
```
java.lang.String resultInterfaceType
```
  - receiverInterfaceType
```
java.lang.String receiverInterfaceType
```
  - leftInterfaceType
```
java.lang.String leftInterfaceType
```
  - rightInterfaceType
```
java.lang.String rightInterfaceType
```
  - trimType
```
int trimType
```
  - TernaryOperators
```
static final java.lang.String[] TernaryOperators
```
  - TernaryMethodNames
```
static final java.lang.String[] TernaryMethodNames
```
  - TernaryResultType
```
static final java.lang.String[] TernaryResultType
```
  - TernaryArgType
```
static final java.lang.String[][] TernaryArgType
```
- Constructor Detail
  - TernaryOperatorNode
```
TernaryOperatorNode(ValueNode receiver,
                    ValueNode leftOperand,
                    ValueNode rightOperand,
                    int kind,
                    ContextManager cm)
```
    Constructor for a TernaryOperatorNode
    
    Parameters:
    
    receiver - The receiver (e.g., string being operated on in substr())
    
    leftOperand - The left operand of the node
    
    rightOperand - The right operand of the node
    
    kind - The kind of the operand
    
    cm - The context manager
  - TernaryOperatorNode
```
TernaryOperatorNode(ValueNode receiver,
                    ValueNode leftOperand,
                    ValueNode rightOperand,
                    int kind,
                    int trimType,
                    ContextManager cm)
```
    Constructor for a TernaryOperatorNode
    
    Parameters:
    
    receiver - The receiver (e.g., string being operated on in substr())
    
    leftOperand - The left operand of the node
    
    rightOperand - The right operand of the node
    
    kind - The kind of the operand
    
    trimType - The trim type
    
    cm - The context manager
- Method Detail
  - constructorMinion
```
private void constructorMinion(ValueNode receiver,
                               ValueNode leftOperand,
                               ValueNode rightOperand,
                               int trimType)
```
  - 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
  - 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 class QueryTreeNode
    
    Parameters:
    
    depth - The depth of this node in the tree
  - 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.
    
    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
    
    aggregates - The aggregate list being built as we find AggregateNodes
    
    Returns:
    
    The new top of the expression tree.
    
    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 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
```
void generateExpression(ExpressionClassBuilder acb,
                        MethodBuilder mb)
                 throws StandardException
```
    Do code generation for this ternary operator.
    
    Overrides:
    
    generateExpression in class ValueNode
    
    Parameters:
    
    acb - The ExpressionClassBuilder for the class we're generating
    
    mb - The method the expression will go into
    
    Throws:
    
    StandardException - Thrown on error
  - setLeftOperand
```
void setLeftOperand(ValueNode newLeftOperand)
```
    Set the leftOperand to the specified ValueNode
    
    Parameters:
    
    newLeftOperand - The new leftOperand
  - getLeftOperand
```
ValueNode getLeftOperand()
```
    Get the leftOperand
    
    Returns:
    
    The current leftOperand.
  - setRightOperand
```
void setRightOperand(ValueNode newRightOperand)
```
    Set the rightOperand to the specified ValueNode
    
    Parameters:
    
    newRightOperand - The new rightOperand
  - getRightOperand
```
ValueNode getRightOperand()
```
    Get the rightOperand
    
    Returns:
    
    The current rightOperand.
  - 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 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
```
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
```
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
```
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)
  - 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
  - trimBind
```
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:
    
    The new top of the expression tree.
    
    Throws:
    
    StandardException - Thrown on error
  - setResultType
```
private void setResultType(TypeId resultType)
                    throws StandardException
```
    Throws:
    
    StandardException
  - locateBind
```
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:
    
    The new top of the expression tree.
    
    Throws:
    
    StandardException - Thrown on error
  - castArgToString
```
protected ValueNode castArgToString(ValueNode vn)
                             throws StandardException
```
    Throws:
    
    StandardException
  - substrBind
```
ValueNode substrBind()
              throws StandardException
```
    Bind substr expression.
    
    Returns:
    
    The new top of the expression tree.
    
    Throws:
    
    StandardException - Thrown on error
  - timestampAddBind
```
private ValueNode timestampAddBind()
                            throws StandardException
```
    Bind TIMESTAMPADD expression.
    
    Returns:
    
    The new top of the expression tree.
    
    Throws:
    
    StandardException - Thrown on error
  - timestampDiffBind
```
private ValueNode timestampDiffBind()
                             throws StandardException
```
    Bind TIMESTAMPDIFF expression.
    
    Returns:
    
    The new top of the expression tree.
    
    Throws:
    
    StandardException - Thrown on error
  - bindDateTimeArg
```
private void bindDateTimeArg(ValueNode arg,
                             int argNumber)
                      throws StandardException
```
    Throws:
    
    StandardException
  - bindParameter
```
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 - 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 - Associate this type with arg if arg is a ? param with no type associated with it
    
    Returns:
    
    true if arg is a ? param with no type associated with it
    
    Throws:
    
    StandardException
  - getReceiver
```
ValueNode getReceiver()
```
  - throwBadType
```
private void throwBadType(java.lang.String funcName,
                          java.lang.String type)
                   throws StandardException
```
    Throws:
    
    StandardException
  - bindToBuiltIn
```
protected void bindToBuiltIn()
                      throws StandardException
```
    Throws:
    
    StandardException
  - getVarcharDescriptor
```
private DataTypeDescriptor getVarcharDescriptor()
```
  - 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 of ValueNode.isEquivalent(org.apache.derby.impl.sql.compile.ValueNode) 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.
    
    Overrides:
    
    isSameNodeKind in class ValueNode
    
    Parameters:
    
    o - The other value node whose kind we want to compare with.
    
    Returns:
    
    true if this and o represent the same logical node type, i.e. kind.
  - 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 class ValueNode
    
    Parameters:
    
    o - the node to compare this ValueNode against.
    
    Returns:
    
    true if the two nodes are equivalent, false otherwise.
    
    Throws:
    
    StandardException

Class TernaryOperatorNode

Field Summary

Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

Field Detail

K_TRIM

K_LOCATE

K_SUBSTRING

K_LIKE

K_TIMESTAMPADD

K_TIMESTAMPDIFF

kind

operator

methodName

receiver

leftOperand

rightOperand

resultInterfaceType

receiverInterfaceType

leftInterfaceType

rightInterfaceType

trimType

TernaryOperators

TernaryMethodNames

TernaryResultType

TernaryArgType

Constructor Detail

TernaryOperatorNode

TernaryOperatorNode

Method Detail

constructorMinion

toString

printSubNodes

bindExpression

preprocess

generateExpression

setLeftOperand

getLeftOperand

setRightOperand

getRightOperand

categorize

remapColumnReferencesToExpressions

isConstantExpression

constantExpression

acceptChildren

trimBind

setResultType

locateBind

castArgToString

substrBind

timestampAddBind

timestampDiffBind

bindDateTimeArg

bindParameter

getReceiver

throwBadType

bindToBuiltIn

getVarcharDescriptor

isSameNodeKind

isEquivalent