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

pack-priv Class CastNode

extends ValueNode
Class Inheritance
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, .Limits, .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.TypeCompiler, .Visitor, org.apache.derby.iapi.types.DataTypeDescriptor, .DataTypeUtilities, .DataValueDescriptor, .NumberDataType, .TypeId, org.apache.derby.iapi.util.JBitSet, .StringUtil

An CastNode represents a cast expression.

Field Summary

Modifier and TypeField and Description
private boolean
assignmentSemantics

Method calls: Argument type has the same semantics as assignment: Section 9.2 (Store assignment).

pack-priv ValueNode
private boolean
externallyGeneratedCastNode

This variable gets set by the parser to indicate that this CAST node has been generated by the parser.

private boolean
pack-priv TypeId
private int
private DataTypeDescriptor
targetUDT

The original, unbound descriptor for the target type, if it is a UDT.

private TableName
udtTargetName

The name of the target type if it's a UDT.

Inherited from org.apache.derby.impl.sql.compile.ValueNode:
transformed

Constructor Summary

AccessConstructor and Description
pack-priv
CastNode(ValueNode
The operand of the node
castOperand
,
DataTypeDescriptor
DataTypeServices (target type of cast)
castTarget
,
ContextManager
The context manager
cm
)

Constructor for a CastNode

pack-priv
CastNode(ValueNode
The operand of the node
castOperand
,
int
CHAR or VARCHAR JDBC type as target
charType
,
int
target type length
charLength
,
ContextManager
The context manager
cm
)

Constructor for a CastNode

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 void
bindCastNodeOnly()

Bind this node but not its child.

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.

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
pack-priv void
generateExpression(ExpressionClassBuilder
The ExpressionClassBuilder for the class we're generating
acb
,
MethodBuilder
The method the code to place the code
mb
)

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

Do code generation for this unary operator.

private ValueNode

Returns:

The new top of the tree (this CastNode or a new Constant)
getCastFromCharConstant
(int
The destination JDBC TypeId
destJDBCTypeId
)

Get a constant representing the cast from a CHAR to another type.

private ValueNode

Returns:

The new top of the tree (this CastNode or a new Constant)
getCastFromIntegralType
(long
integral type as a long to cast from
longValue
,
int
The destination JDBC TypeId
destJDBCTypeId
)

Get a constant representing the cast from an integral type to another type.

private ValueNode

Returns:

The new top of the tree (this CastNode or a new Constant)
getCastFromNumericType
(DataValueDescriptor
non-integral type a a double to cast from
constantValue
,
int
The destination JDBC TypeId
destJDBCTypeId
)

Get a constant representing the cast from a non-integral type to another type.

pack-priv Object

Returns:

An Object representing the bind time value of this expression tree. (null if not a bind time constant.)
getConstantValueAsObject
()

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

Return an Object representing the bind time value of this expression tree.

protected int
getOrderableVariantType()

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

Return the variant type for the underlying expression.

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 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
setAssignmentSemantics()

Set assignmentSemantics to true.

pack-priv void
setForDataTypeFunction(boolean
true to use function conversion rules
b
)

set this to be a dataTypeScalarFunction

pack-priv void
setForExternallyGeneratedCASTnode()

This method gets called by the parser to indiciate that this CAST node has been generated by the parser.

pack-priv void
setTargetUDTName(TableName
the name of the target type
name
)

Set the target type name if this is a cast to a UDT.

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.ValueNode:
bindExpressionchangeToCNFcheckIsBooleancheckTopPredicatesForEqualsConditionscopyFieldseliminateNotsevaluateConstantExpressionsgenEqualsFalseTreegenerategenIsNullTreegenSQLJavaSQLTreegetClonegetColumnNamegetDataValueFactorygetSchemaNamegetSourceResultColumngetTableNamegetTablesReferencedgetTransformedgetTypeCompilergetTypeIdgetTypeServicesisBinaryEqualsOperatorNodeisBooleanFalseisBooleanTrueisCloneableisInListProbeNodeisParameterNodeisRelationalOperatorisSameNodeKindoptimizableEqualityNodeputAndsOnToprequiresTypeFromContextselectivitysetCollationInfosetCollationInfosetCollationUsingCompilationSchemasetCollationUsingCompilationSchemasetNullabilitysetTransformedsetTypesetTypesetTypeupdatableByCursorverifyChangeToCNFverifyEliminateNotsverifyPutAndsOnTop

Field Detail

assignmentSemanticsback to summary
private boolean assignmentSemantics

Method calls: Argument type has the same semantics as assignment: Section 9.2 (Store assignment). There, General Rule 2.b.v.2 says that the database should raise an exception if truncation occurs when stuffing a string value into a VARCHAR, so make sure CAST doesn't issue warning only.

castOperandback to summary
pack-priv ValueNode castOperand
externallyGeneratedCastNodeback to summary
private boolean externallyGeneratedCastNode

This variable gets set by the parser to indicate that this CAST node has been generated by the parser. This means that we should use the collation info of the current compilation schema for this node's collation setting. If this variable does not get set to true, then it means that this CAST node has been an internally generated node and we should not touch the collation info set for this CAST node because it has been already set correctly by the class that generated this CAST node. Collation info is part of the DataTypeDescriptor that's defined on the ValueNode (the super class of this CastNode class)

forDataTypeFunctionback to summary
private boolean forDataTypeFunction
sourceCTIback to summary
pack-priv TypeId sourceCTI
targetCharTypeback to summary
private int targetCharType
targetUDTback to summary
private DataTypeDescriptor targetUDT

The original, unbound descriptor for the target type, if it is a UDT.

udtTargetNameback to summary
private TableName udtTargetName

The name of the target type if it's a UDT. It is partly redundant, as the name can also be retrieved from the type descriptor. Additionally, it contains information about the location of the UDT name in the query text, which is useful if the query text needs to be rewritten. (Useful for example when rewriting a CHECK constraint definition to have fully qualified names before storing it in the dictionary.) This field is only set for explicit casts to a UDT.

Constructor Detail

CastNodeback to summary
pack-priv CastNode(ValueNode castOperand, DataTypeDescriptor castTarget, ContextManager cm) throws StandardException

Constructor for a CastNode

Parameters
castOperand:ValueNode

The operand of the node

castTarget:DataTypeDescriptor

DataTypeServices (target type of cast)

cm:ContextManager

The context manager

Exceptions
StandardException:
Thrown on error
CastNodeback to summary
pack-priv CastNode(ValueNode castOperand, int charType, int charLength, ContextManager cm) throws StandardException

Constructor for a CastNode

Parameters
castOperand:ValueNode

The operand of the node

charType:int

CHAR or VARCHAR JDBC type as target

charLength:int

target type length

cm:ContextManager

The context manager

Exceptions
StandardException:
Thrown on error

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
bindCastNodeOnlyback to summary
pack-priv void bindCastNodeOnly() throws StandardException

Bind this node but not its child. Caller has already bound the child. This is useful for when we generate a CastNode during binding after having already bound the child.

Exceptions
StandardException:
Thrown on error
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
@SuppressWarnings:fallthrough
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
genDataValueConversionback to summary
private void genDataValueConversion(ExpressionClassBuilder acb, MethodBuilder mb) throws StandardException
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 code to place the code

Annotations
@Override
Exceptions
StandardException:
Thrown on error
getCastFromCharConstantback to summary
private ValueNode getCastFromCharConstant(int destJDBCTypeId) throws StandardException

Get a constant representing the cast from a CHAR to another type. If this is not an "easy" cast to perform, then just return this cast node. Here's what we think is "easy": source destination ------ ----------- char boolean char date/time/ts char non-decimal numeric

Parameters
destJDBCTypeId:int

The destination JDBC TypeId

Returns:ValueNode

The new top of the tree (this CastNode or a new Constant)

Exceptions
StandardException:
Thrown on error
getCastFromIntegralTypeback to summary
private ValueNode getCastFromIntegralType(long longValue, int destJDBCTypeId) throws StandardException

Get a constant representing the cast from an integral type to another type. If this is not an "easy" cast to perform, then just return this cast node. Here's what we think is "easy": source destination ------ ----------- integral type non-decimal numeric integral type char

Parameters
longValue:long

integral type as a long to cast from

destJDBCTypeId:int

The destination JDBC TypeId

Returns:ValueNode

The new top of the tree (this CastNode or a new Constant)

Exceptions
StandardException:
Thrown on error
getCastFromNumericTypeback to summary
private ValueNode getCastFromNumericType(DataValueDescriptor constantValue, int destJDBCTypeId) throws StandardException

Get a constant representing the cast from a non-integral type to another type. If this is not an "easy" cast to perform, then just return this cast node. Here's what we think is "easy": source destination ------ ----------- non-integral type non-decimal numeric non-integral type char

Parameters
constantValue:DataValueDescriptor

non-integral type a a double to cast from

destJDBCTypeId:int

The destination JDBC TypeId

Returns:ValueNode

The new top of the tree (this CastNode or a new Constant)

Exceptions
StandardException:
Thrown on error
getConstantValueAsObjectback to summary
pack-priv Object getConstantValueAsObject() throws StandardException

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

Return an Object representing the bind time value of this expression tree. If the expression tree does not evaluate to a constant at bind time then we return null. This is useful for bind time resolution of VTIs.

Resolve

What do we do for primitives?

Returns:Object

An Object representing the bind time value of this expression tree. (null if not a bind time constant.)

Annotations
@Override
Exceptions
StandardException:
Thrown on error
getOrderableVariantTypeback to summary
protected int getOrderableVariantType() throws StandardException

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

Doc from 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)

Returns:int

The variant type for the underlying expression.

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.

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
setAssignmentSemanticsback to summary
pack-priv void setAssignmentSemantics()

Set assignmentSemantics to true. Used by method calls for casting actual arguments

setForDataTypeFunctionback to summary
pack-priv void setForDataTypeFunction(boolean b)

set this to be a dataTypeScalarFunction

Parameters
b:boolean

true to use function conversion rules

setForExternallyGeneratedCASTnodeback to summary
pack-priv void setForExternallyGeneratedCASTnode()

This method gets called by the parser to indiciate that this CAST node has been generated by the parser. This means that we should use the collation info of the current compilation schmea for this node's collation setting. If this method does not get called, then it means that this CAST node has been an internally generated node and we should not touch the collation of this CAST node because it has been already set correctly by the class that generated this CAST node.

setTargetUDTNameback to summary
pack-priv void setTargetUDTName(TableName name)

Set the target type name if this is a cast to a UDT.

Parameters
name:TableName

the name of the target type

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