Class/Object

org.apache.spark.sql.catalyst.expressions

Cast

Related Docs: object Cast | package expressions

Permalink

case class Cast(child: Expression, dataType: DataType) extends UnaryExpression with NullIntolerant with Product with Serializable

Cast the child expression to the target data type.

Linear Supertypes
Serializable, Serializable, NullIntolerant, UnaryExpression, Expression, TreeNode[Expression], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Cast
  2. Serializable
  3. Serializable
  4. NullIntolerant
  5. UnaryExpression
  6. Expression
  7. TreeNode
  8. Product
  9. Equals
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Cast(child: Expression, dataType: DataType)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(number: Int): Expression

    Permalink

    Returns the tree node at the specified number.

    Returns the tree node at the specified number. Numbers for each node can be found in the numberedTreeString.

    Definition Classes
    TreeNode
  5. def argString: String

    Permalink

    Returns a string representing the arguments to this node, minus any children

    Returns a string representing the arguments to this node, minus any children

    Definition Classes
    TreeNode
  6. def asCode: String

    Permalink

    Returns a 'scala code' representation of this TreeNode and its children.

    Returns a 'scala code' representation of this TreeNode and its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure' TreeNodes that only contain primitives and other TreeNodes, the result can be pasted in the REPL to build an equivalent Tree.

    Definition Classes
    TreeNode
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. lazy val canonicalized: Expression

    Permalink

    Returns an expression where a best effort attempt has been made to transform this in a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, etc.) See Canonicalize for more details.

    Returns an expression where a best effort attempt has been made to transform this in a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, etc.) See Canonicalize for more details.

    deterministic expressions where this.canonicalized == other.canonicalized will always evaluate to the same result.

    Definition Classes
    Expression
  9. def checkInputDataTypes(): TypeCheckResult

    Permalink

    Checks the input data types, returns TypeCheckResult.success if it's valid, or returns a TypeCheckResult with an error message if invalid.

    Checks the input data types, returns TypeCheckResult.success if it's valid, or returns a TypeCheckResult with an error message if invalid. Note: it's not valid to call this method until childrenResolved == true.

    Definition Classes
    CastExpression
  10. val child: Expression

    Permalink
    Definition Classes
    CastUnaryExpression
  11. def children: Seq[Expression]

    Permalink

    Returns a Seq of the children of this node.

    Returns a Seq of the children of this node. Children should not change. Immutability required for containsChild optimization

    Definition Classes
    UnaryExpressionTreeNode
  12. def childrenResolved: Boolean

    Permalink

    Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.

    Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.

    Definition Classes
    Expression
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]

    Permalink

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Definition Classes
    TreeNode
  15. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]

    Permalink

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

    Definition Classes
    TreeNode
  16. lazy val containsChild: Set[TreeNode[_]]

    Permalink
    Definition Classes
    TreeNode
  17. val dataType: DataType

    Permalink

    Returns the DataType of the result of evaluating this expression.

    Returns the DataType of the result of evaluating this expression. It is invalid to query the dataType of an unresolved expression (i.e., when resolved == false).

    Definition Classes
    CastExpression
  18. def defineCodeGen(ctx: CodegenContext, ev: ExprCode, f: (String) ⇒ String): ExprCode

    Permalink

    Called by unary expressions to generate a code block that returns null if its parent returns null, and if not null, use f to generate the expression.

    Called by unary expressions to generate a code block that returns null if its parent returns null, and if not null, use f to generate the expression.

    As an example, the following does a boolean inversion (i.e. NOT).

    defineCodeGen(ctx, ev, c => s"!($c)")
    f

    function that accepts a variable name and returns Java code to compute the output.

    Attributes
    protected
    Definition Classes
    UnaryExpression
  19. def deterministic: Boolean

    Permalink

    Returns true when the current expression always return the same result for fixed inputs from children.

    Returns true when the current expression always return the same result for fixed inputs from children.

    Note that this means that an expression should be considered as non-deterministic if: - if it relies on some mutable internal state, or - if it relies on some implicit input that is not part of the children expression list. - if it has non-deterministic child or children.

    An example would be SparkPartitionID that relies on the partition id returned by TaskContext. By default leaf expressions are deterministic as Nil.forall(_.deterministic) returns true.

    Definition Classes
    Expression
  20. def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode

    Permalink

    Returns Java source code that can be compiled to evaluate this expression.

    Returns Java source code that can be compiled to evaluate this expression. The default behavior is to call the eval method of the expression. Concrete expression implementations should override this to do actual code generation.

    ctx

    a CodegenContext

    ev

    an ExprCode with unique terms.

    returns

    an ExprCode containing the Java source code to generate the given expression

    Definition Classes
    CastExpression
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def eval(input: InternalRow): Any

    Permalink

    Default behavior of evaluation according to the default nullability of UnaryExpression.

    Default behavior of evaluation according to the default nullability of UnaryExpression. If subclass of UnaryExpression override nullable, probably should also override this.

    Definition Classes
    UnaryExpressionExpression
  23. def fastEquals(other: TreeNode[_]): Boolean

    Permalink

    Faster version of equality which short-circuits when two treeNodes are the same instance.

    Faster version of equality which short-circuits when two treeNodes are the same instance. We don't just override Object.equals, as doing so prevents the scala compiler from generating case class equals methods

    Definition Classes
    TreeNode
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def find(f: (Expression) ⇒ Boolean): Option[Expression]

    Permalink

    Find the first TreeNode that satisfies the condition specified by f.

    Find the first TreeNode that satisfies the condition specified by f. The condition is recursively applied to this node and all of its children (pre-order).

    Definition Classes
    TreeNode
  26. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]

    Permalink

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Definition Classes
    TreeNode
  27. def foldable: Boolean

    Permalink

    Returns true when an expression is a candidate for static evaluation before the query is executed.

    Returns true when an expression is a candidate for static evaluation before the query is executed.

    The following conditions are used to determine suitability for constant folding:

    Definition Classes
    UnaryExpressionExpression
  28. def foreach(f: (Expression) ⇒ Unit): Unit

    Permalink

    Runs the given function on this node and then recursively on children.

    Runs the given function on this node and then recursively on children.

    f

    the function to be applied to each node in the tree.

    Definition Classes
    TreeNode
  29. def foreachUp(f: (Expression) ⇒ Unit): Unit

    Permalink

    Runs the given function recursively on children then on this node.

    Runs the given function recursively on children then on this node.

    f

    the function to be applied to each node in the tree.

    Definition Classes
    TreeNode
  30. def genCode(ctx: CodegenContext): ExprCode

    Permalink

    Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.

    Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.

    ctx

    a CodegenContext

    returns

    ExprCode

    Definition Classes
    Expression
  31. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder): StringBuilder

    Permalink

    Appends the string represent of this node and its children to the given StringBuilder.

    Appends the string represent of this node and its children to the given StringBuilder.

    The i-th element in lastChildren indicates whether the ancestor of the current node at depth i + 1 is the last child of its own parent node. The depth of the root node is 0, and lastChildren for the root node should be empty.

    Definition Classes
    TreeNode
  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  33. def getNodeNumbered(number: trees.MutableInt): Expression

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  34. def hashCode(): Int

    Permalink
    Definition Classes
    TreeNode → AnyRef → Any
  35. def innerChildren: Seq[Expression]

    Permalink

    All the nodes that are parts of this node.

    All the nodes that are parts of this node.

    For example:

    WholeStageCodegen +- SortMergeJoin |-- InputAdapter | +-- Sort +-- InputAdapter +-- Sort

    the innerChildren of WholeStageCodegen will be Seq(SortMergeJoin), it will generate a tree string like this:

    WholeStageCodegen : +- SortMergeJoin : :- INPUT : :- INPUT :- Sort :- Sort

    Attributes
    protected
    Definition Classes
    TreeNode
  36. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  37. def jsonFields: List[JField]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  38. def makeCopy(newArgs: Array[AnyRef]): Expression

    Permalink

    Creates a copy of this type of tree node after a transformation.

    Creates a copy of this type of tree node after a transformation. Must be overridden by child classes that have constructor arguments that are not present in the productIterator.

    newArgs

    the new product arguments.

    Definition Classes
    TreeNode
  39. def map[A](f: (Expression) ⇒ A): Seq[A]

    Permalink

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    f

    the function to be applied.

    Definition Classes
    TreeNode
  40. def mapChildren(f: (Expression) ⇒ Expression): Expression

    Permalink

    Returns a copy of this node where f has been applied to all the nodes children.

    Returns a copy of this node where f has been applied to all the nodes children.

    Definition Classes
    TreeNode
  41. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  42. def nodeName: String

    Permalink

    Returns the name of this type of TreeNode.

    Returns the name of this type of TreeNode. Defaults to the class name. Note that we remove the "Exec" suffix for physical operators here.

    Definition Classes
    TreeNode
  43. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  45. def nullSafeCodeGen(ctx: CodegenContext, ev: ExprCode, f: (String) ⇒ String): ExprCode

    Permalink

    Called by unary expressions to generate a code block that returns null if its parent returns null, and if not null, use f to generate the expression.

    Called by unary expressions to generate a code block that returns null if its parent returns null, and if not null, use f to generate the expression.

    f

    function that accepts the non-null evaluation result name of child and returns Java code to compute the output.

    Attributes
    protected
    Definition Classes
    UnaryExpression
  46. def nullSafeEval(input: Any): Any

    Permalink

    Called by default eval implementation.

    Called by default eval implementation. If subclass of UnaryExpression keep the default nullability, they can override this method to save null-check code. If we need full control of evaluation process, we should override eval.

    Attributes
    protected
    Definition Classes
    CastUnaryExpression
  47. def nullable: Boolean

    Permalink
    Definition Classes
    CastUnaryExpressionExpression
  48. def numberedTreeString: String

    Permalink

    Returns a string representation of the nodes in this tree, where each operator is numbered.

    Returns a string representation of the nodes in this tree, where each operator is numbered. The numbers can be used with apply to easily access specific subtrees.

    Definition Classes
    TreeNode
  49. val origin: Origin

    Permalink
    Definition Classes
    TreeNode
  50. def otherCopyArgs: Seq[AnyRef]

    Permalink

    Args to the constructor that should be copied, but not transformed.

    Args to the constructor that should be copied, but not transformed. These are appended to the transformed args automatically by makeCopy

    Attributes
    protected
    Definition Classes
    TreeNode
  51. def prettyJson: String

    Permalink
    Definition Classes
    TreeNode
  52. def prettyName: String

    Permalink

    Returns a user-facing string representation of this expression's name.

    Returns a user-facing string representation of this expression's name. This should usually match the name of the function in SQL.

    Definition Classes
    Expression
  53. def references: AttributeSet

    Permalink
    Definition Classes
    Expression
  54. lazy val resolved: Boolean

    Permalink

    Returns true if this expression and all its children have been resolved to a specific schema and input data types checking passed, and false if it still contains any unresolved placeholders or has data types mismatch.

    Returns true if this expression and all its children have been resolved to a specific schema and input data types checking passed, and false if it still contains any unresolved placeholders or has data types mismatch. Implementations of expressions should override this if the resolution of this type of expression involves more than just the resolution of its children and type checking.

    Definition Classes
    Expression
  55. def semanticEquals(other: Expression): Boolean

    Permalink

    Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e.

    Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e. capitalization of names in attributes may be different).

    See Canonicalize for more details.

    Definition Classes
    Expression
  56. def semanticHash(): Int

    Permalink

    Returns a hashCode for the calculation performed by this expression.

    Returns a hashCode for the calculation performed by this expression. Unlike the standard hashCode, an attempt has been made to eliminate cosmetic differences.

    See Canonicalize for more details.

    Definition Classes
    Expression
  57. def simpleString: String

    Permalink

    String representation of this node without any children.

    String representation of this node without any children.

    Definition Classes
    ExpressionTreeNode
  58. def sql: String

    Permalink

    Returns SQL representation of this expression.

    Returns SQL representation of this expression. For expressions extending NonSQLExpression, this method may return an arbitrary user facing string.

    Definition Classes
    CastExpression
  59. def stringArgs: Iterator[Any]

    Permalink

    The arguments that should be included in the arg string.

    The arguments that should be included in the arg string. Defaults to the productIterator.

    Attributes
    protected
    Definition Classes
    TreeNode
  60. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  61. def toJSON: String

    Permalink
    Definition Classes
    TreeNode
  62. def toString(): String

    Permalink
    Definition Classes
    CastExpressionTreeNode → AnyRef → Any
  63. def transform(rule: PartialFunction[Expression, Expression]): Expression

    Permalink

    Returns a copy of this node where rule has been recursively applied to the tree.

    Returns a copy of this node where rule has been recursively applied to the tree. When rule does not apply to a given node it is left unchanged. Users should not expect a specific directionality. If a specific directionality is needed, transformDown or transformUp should be used.

    rule

    the function use to transform this nodes children

    Definition Classes
    TreeNode
  64. def transformChildren(rule: PartialFunction[Expression, Expression], nextOperation: (Expression, PartialFunction[Expression, Expression]) ⇒ Expression): Expression

    Permalink

    Returns a copy of this node where rule has been recursively applied to all the children of this node.

    Returns a copy of this node where rule has been recursively applied to all the children of this node. When rule does not apply to a given node it is left unchanged.

    rule

    the function used to transform this nodes children

    Attributes
    protected
    Definition Classes
    TreeNode
  65. def transformDown(rule: PartialFunction[Expression, Expression]): Expression

    Permalink

    Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order).

    Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order). When rule does not apply to a given node it is left unchanged.

    rule

    the function used to transform this nodes children

    Definition Classes
    TreeNode
  66. def transformUp(rule: PartialFunction[Expression, Expression]): Expression

    Permalink

    Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order).

    Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order). When rule does not apply to a given node, it is left unchanged.

    rule

    the function use to transform this nodes children

    Definition Classes
    TreeNode
  67. def treeChildren: Seq[Expression]

    Permalink

    All the nodes that will be used to generate tree string.

    All the nodes that will be used to generate tree string.

    For example:

    WholeStageCodegen +-- SortMergeJoin |-- InputAdapter | +-- Sort +-- InputAdapter +-- Sort

    the treeChildren of WholeStageCodegen will be Seq(Sort, Sort), it will generate a tree string like this:

    WholeStageCodegen : +- SortMergeJoin : :- INPUT : :- INPUT :- Sort :- Sort

    Attributes
    protected
    Definition Classes
    TreeNode
  68. def treeString: String

    Permalink

    Returns a string representation of the nodes in this tree

    Returns a string representation of the nodes in this tree

    Definition Classes
    TreeNode
  69. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. def withNewChildren(newChildren: Seq[Expression]): Expression

    Permalink

    Returns a copy of this node with the children replaced.

    Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from NullIntolerant

Inherited from UnaryExpression

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped