Trait

org.apache.spark.sql.catalyst.expressions

ExpectsInputTypes

Related Doc: package expressions

Permalink

trait ExpectsInputTypes extends Expression

An trait that gets mixin to define the expected input types of an expression.

This trait is typically used by operator expressions (e.g. Add, Subtract) to define expected input types without any implicit casting.

Most function expressions (e.g. Substring should extends ImplicitCastInputTypes) instead.

Linear Supertypes
Expression, TreeNode[Expression], Product, Equals, AnyRef, Any
Known Subclasses
Abs, Acos, Add, AddMonths, AggregateFunction, And, ArrayContains, Ascii, Asin, Atan, Atan2, Average, Base64, Bin, BinaryArithmetic, BinaryComparison, BinaryMathExpression, BinaryOperator, BitwiseAnd, BitwiseNot, BitwiseOr, BitwiseXor, Cbrt, Ceil, CentralMomentAgg, Concat, ConcatWs, Contains, Conv, Corr, Cos, Cosh, Count, Crc32, DateAdd, DateDiff, DateFormatClass, DateSub, DayOfMonth, DayOfYear, DeclarativeAggregate, Decode, Divide, Encode, EndsWith, EqualNullSafe, EqualTo, Exp, Expm1, Factorial, FindInSet, First, Floor, FormatNumber, FormatString, FromUTCTimestamp, FromUnixTime, GetArrayItem, GetJsonObject, GetMapValue, GreaterThan, GreaterThanOrEqual, Hex, Hour, HyperLogLogPlusPlus, Hypot, ImperativeAggregate, ImplicitCastInputTypes, In, InitCap, IsNaN, Kurtosis, Last, LastDay, Length, LessThan, LessThanOrEqual, Levenshtein, Like, Log, Log10, Log1p, Log2, Logarithm, Lower, Max, MaxOf, Md5, Min, MinOf, Minute, Month, MonthsBetween, Multiply, NaNvl, NextDay, Not, Or, Pmod, Pow, Quarter, RLike, RegExpExtract, RegExpReplace, Remainder, Rint, Round, ScalaUDF, Second, Sha1, Sha2, ShiftLeft, ShiftRight, ShiftRightUnsigned, Signum, Sin, Sinh, Size, Skewness, SortArray, SoundEx, Sqrt, StartsWith, StddevPop, StddevSamp, String2StringExpression, StringInstr, StringLPad, StringLocate, StringPredicate, StringRPad, StringRegexExpression, StringRepeat, StringReverse, StringSpace, StringSplit, StringTranslate, StringTrim, StringTrimLeft, StringTrimRight, Substring, SubstringIndex, Subtract, Sum, Tan, Tanh, TimeAdd, TimeSub, ToDate, ToDegrees, ToRadians, ToUTCTimestamp, ToUnixTimestamp, TruncDate, UnBase64, UnaryLogExpression, UnaryMathExpression, UnaryMinus, UnaryPositive, Unhex, UnixTime, UnixTimestamp, UnwrapOption, Upper, VariancePop, VarianceSamp, WeekOfYear, WrapOption, Year
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExpectsInputTypes
  2. Expression
  3. TreeNode
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract 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
    TreeNode
  3. abstract def 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
    Expression
  4. abstract def eval(input: InternalRow = null): Any

    Permalink

    Returns the result of evaluating this expression on a given input Row

    Returns the result of evaluating this expression on a given input Row

    Definition Classes
    Expression
  5. abstract def genCode(ctx: CodeGenContext, ev: GeneratedExpressionCode): String

    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 GeneratedExpressionCode with unique terms.

    returns

    Java source code

    Attributes
    protected
    Definition Classes
    Expression
  6. abstract def inputTypes: Seq[AbstractDataType]

    Permalink

    Expected input types from child expressions.

    Expected input types from child expressions. The i-th position in the returned seq indicates the type requirement for the i-th child.

    The possible values at each position are: 1. a specific data type, e.g. LongType, StringType. 2. a non-leaf abstract data type, e.g. NumericType, IntegralType, FractionalType.

  7. abstract def nullable: Boolean

    Permalink
    Definition Classes
    Expression
  8. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  9. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product

Concrete 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. 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
    ExpectsInputTypesExpression
  9. 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
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. 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
  12. 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
  13. lazy val containsChild: Set[TreeNode[_]]

    Permalink
    Definition Classes
    TreeNode
  14. 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
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. 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
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. 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
  20. 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
  21. 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
    Expression
  22. 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
  23. 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
  24. def gen(ctx: CodeGenContext): GeneratedExpressionCode

    Permalink

    Returns an GeneratedExpressionCode, which contains Java source code that can be used to generate the result of evaluating the expression on an input row.

    Returns an GeneratedExpressionCode, which contains Java source code that can be used to generate the result of evaluating the expression on an input row.

    ctx

    a CodeGenContext

    returns

    GeneratedExpressionCode

    Definition Classes
    Expression
  25. 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.

    Attributes
    protected
    Definition Classes
    TreeNode
  26. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode
  31. 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
  32. 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
  33. 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
  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. 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.

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

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

    Permalink
    Definition Classes
    AnyRef
  38. 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
  39. val origin: Origin

    Permalink
    Definition Classes
    TreeNode
  40. 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
  41. def prettyJson: String

    Permalink
    Definition Classes
    TreeNode
  42. 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
  43. def prettyString: String

    Permalink

    Returns a user-facing string representation of this expression, i.e.

    Returns a user-facing string representation of this expression, i.e. does not have developer centric debugging information like the expression id.

    Definition Classes
    Expression
  44. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  45. def productPrefix: String

    Permalink
    Definition Classes
    Product
  46. def references: AttributeSet

    Permalink
    Definition Classes
    Expression
  47. 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
  48. 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).

    Definition Classes
    Expression
  49. def semanticHash(): Int

    Permalink

    Returns the hash for this expression.

    Returns the hash for this expression. Expressions that compute the same result, even if they differ cosmetically should return the same hash.

    Definition Classes
    Expression
  50. def simpleString: String

    Permalink

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    ExpressionTreeNode
  51. 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
  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  53. def toJSON: String

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

    Permalink
    Definition Classes
    ExpressionTreeNode → AnyRef → Any
  55. 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
  56. 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
  57. 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
  58. 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
  59. 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
  60. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. 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 Expression

Inherited from TreeNode[Expression]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped