Packages

case class Lead(input: Expression, offset: Expression, default: Expression, ignoreNulls: Boolean) extends FrameLessOffsetWindowFunction with TernaryLike[Expression] with Product with Serializable

The Lead function returns the value of input at the offsetth row after the current row in the window. Offsets start at 0, which is the current row. The offset must be constant integer value. The default offset is 1. When the value of input is null at the offsetth row, null is returned. If there is no such offset row, the default expression is evaluated.

Annotations
@ExpressionDescription()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Lead
  2. Serializable
  3. TernaryLike
  4. FrameLessOffsetWindowFunction
  5. ImplicitCastInputTypes
  6. ExpectsInputTypes
  7. Unevaluable
  8. OffsetWindowFunction
  9. WindowFunction
  10. Expression
  11. TreeNode
  12. TreePatternBits
  13. Product
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Lead()
  2. new Lead(input: Expression)
  3. new Lead(input: Expression, offset: Expression)
  4. new Lead(input: Expression, offset: Expression, default: Expression)
  5. new Lead(input: Expression, offset: Expression, default: Expression, ignoreNulls: Boolean)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(number: Int): TreeNode[_]

    Returns the tree node at the specified number, used primarily for interactive debugging.

    Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.

    Note that this cannot return BaseType because logical plan's plan node might return physical plan for innerChildren, e.g. in-memory relation logical plan node has a reference to the physical plan node it is referencing.

    Definition Classes
    TreeNode
  5. def argString(maxFields: Int): String

    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

    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
    Definition Classes
    Any
  8. lazy val canonicalized: Expression

    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

    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
    FrameLessOffsetWindowFunctionExpectsInputTypesExpression
  10. final lazy val children: Seq[Expression]
    Definition Classes
    TernaryLike
    Annotations
    @transient()
  11. def childrenResolved: Boolean

    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
  12. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  13. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]

    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
  14. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]

    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
  15. def collectLeaves(): Seq[Expression]

    Returns a Seq containing the leaves in this tree.

    Returns a Seq containing the leaves in this tree.

    Definition Classes
    TreeNode
  16. final def containsAllPatterns(patterns: TreePattern*): Boolean

    returns

    true if every bit for patterns is set; false otherwise.

    Definition Classes
    TreePatternBits
  17. final def containsAnyPattern(patterns: TreePattern*): Boolean

    returns

    true if at least one bit for patterns is set; false otherwise.

    Definition Classes
    TreePatternBits
  18. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  19. final def containsPattern(t: TreePattern): Boolean

    returns

    true if the bit for t is set; false otherwise.

    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  20. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  21. def dataType: DataType

    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
    FrameLessOffsetWindowFunctionExpression
  22. val default: Expression

    Default result value for the function when the offsetth row does not exist.

    Default result value for the function when the offsetth row does not exist.

    Definition Classes
    LeadOffsetWindowFunction
  23. lazy val deterministic: Boolean

    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. The non-deterministic expressions should not change in number and order. They should not be evaluated during the query planning.

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

    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
  24. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode

    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

    Attributes
    protected
    Definition Classes
    UnevaluableExpression
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def eval(input: InternalRow = null): Any

    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
    UnevaluableExpression
  27. lazy val fakeFrame: SpecifiedWindowFrame

    A fake window frame which is used to hold the offset information.

    A fake window frame which is used to hold the offset information. It's used as a key to group by offset window functions in WindowExecBase.windowFrameExpressionFactoryPairs, as offset window functions with the same offset and same window frame can be evaluated together.

    Definition Classes
    OffsetWindowFunction
  28. def fastEquals(other: TreeNode[_]): Boolean

    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
  29. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  30. def find(f: (Expression) => Boolean): Option[Expression]

    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
  31. def first: Expression
    Definition Classes
    LeadTernaryLike
  32. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  33. def flatMap[A](f: (Expression) => TraversableOnce[A]): Seq[A]

    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
  34. final def foldable: Boolean

    Unevaluable is not foldable because we don't have an eval for it.

    Unevaluable is not foldable because we don't have an eval for it.

    Definition Classes
    UnevaluableExpression
  35. def foreach(f: (Expression) => Unit): Unit

    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
  36. def foreachUp(f: (Expression) => Unit): Unit

    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
  37. lazy val frame: WindowFrame

    Frame in which the window operator must be executed.

    Frame in which the window operator must be executed.

    Definition Classes
    FrameLessOffsetWindowFunctionWindowFunction
  38. def genCode(ctx: CodegenContext): ExprCode

    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
  39. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) => Unit, verbose: Boolean, prefix: String = "", addSuffix: Boolean = false, maxFields: Int, printNodeId: Boolean, indent: Int = 0): Unit

    Appends the string representation of this node and its children to the given Writer.

    Appends the string representation of this node and its children to the given Writer.

    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.

    Note that this traversal (numbering) order must be the same as getNodeNumbered.

    Definition Classes
    TreeNode
  40. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def getDefaultTreePatternBits: BitSet

    Default tree pattern for a TreeNode.

    Default tree pattern for a TreeNode.

    Attributes
    protected
    Definition Classes
    TreeNode
  42. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  43. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  44. val ignoreNulls: Boolean

    An optional specification that indicates the offset window function should skip null values in the determination of which row to use.

    An optional specification that indicates the offset window function should skip null values in the determination of which row to use.

    Definition Classes
    LeadOffsetWindowFunction
  45. def innerChildren: Seq[TreeNode[_]]

    All the nodes that should be shown as a inner nested tree of this node.

    All the nodes that should be shown as a inner nested tree of this node. For example, this can be used to show sub-queries.

    Definition Classes
    TreeNode
  46. val input: Expression

    Input expression to evaluate against a row which a number of rows below or above (depending on the value and sign of the offset) the starting row (current row if isRelative=true, or the first row of the window frame otherwise).

    Input expression to evaluate against a row which a number of rows below or above (depending on the value and sign of the offset) the starting row (current row if isRelative=true, or the first row of the window frame otherwise).

    Definition Classes
    LeadOffsetWindowFunction
  47. def inputTypes: Seq[AbstractDataType]

    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.

    Definition Classes
    FrameLessOffsetWindowFunctionExpectsInputTypes
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def isRuleIneffective(ruleId: RuleId): Boolean

    Whether this TreeNode and its subtree have been marked as ineffective for the rule with id ruleId.

    Whether this TreeNode and its subtree have been marked as ineffective for the rule with id ruleId.

    ruleId

    the unique id of the rule

    returns

    true if the rule has been marked as ineffective; false otherwise. If ruleId is UnknownId, it returns false.

    Attributes
    protected
    Definition Classes
    TreeNode
  50. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  51. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression

    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.

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

    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
  53. def map[A](f: (Expression) => A): Seq[A]

    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
  54. final def mapChildren(f: (Expression) => Expression): Expression
    Definition Classes
    TernaryLike
  55. def mapProductIterator[B](f: (Any) => B)(implicit arg0: ClassTag[B]): Array[B]

    Efficient alternative to productIterator.map(f).toArray.

    Efficient alternative to productIterator.map(f).toArray.

    Attributes
    protected
    Definition Classes
    TreeNode
  56. def markRuleAsIneffective(ruleId: RuleId): Unit

    Mark that a rule (with id ruleId) is ineffective for this TreeNode and its subtree.

    Mark that a rule (with id ruleId) is ineffective for this TreeNode and its subtree.

    ruleId

    the unique identifier of the rule. If ruleId is UnknownId, it is a no-op.

    Attributes
    protected
    Definition Classes
    TreeNode
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def nodeName: String

    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
  59. val nodePatterns: Seq[TreePattern]

    returns

    a sequence of tree pattern enums in a TreeNode T. It does not include propagated patterns in the subtree of T.

    Attributes
    protected
    Definition Classes
    TreeNode
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  62. def nullable: Boolean
  63. def numberedTreeString: String

    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 TreeNode.apply to easily access specific subtrees.

    The numbers are based on depth-first traversal of the tree (with innerChildren traversed first before children).

    Definition Classes
    TreeNode
  64. val offset: Expression

    (Foldable) expression that contains the number of rows between the current row and the row where the input expression is evaluated.

    (Foldable) expression that contains the number of rows between the current row and the row where the input expression is evaluated. If offset is a positive integer, it means that the direction of the offset is from front to back. If it is a negative integer, the direction of the offset is from back to front. If it is zero, it means that the offset is ignored and use current row.

    Definition Classes
    LeadOffsetWindowFunction
  65. val origin: Origin
    Definition Classes
    TreeNode
  66. def otherCopyArgs: Seq[AnyRef]

    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
  67. def p(number: Int): Expression

    Returns the tree node at the specified number, used primarily for interactive debugging.

    Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.

    This is a variant of apply that returns the node as BaseType (if the type matches).

    Definition Classes
    TreeNode
  68. def prettyJson: String
    Definition Classes
    TreeNode
  69. def prettyName: String

    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
  70. def productElementNames: Iterator[String]
    Definition Classes
    Product
  71. def references: AttributeSet
    Definition Classes
    Expression
  72. lazy val resolved: Boolean

    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
  73. def second: Expression
    Definition Classes
    LeadTernaryLike
  74. final def semanticEquals(other: Expression): Boolean

    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
  75. def semanticHash(): Int

    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
  76. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  77. def simpleString(maxFields: Int): String

    ONE line description of this node.

    ONE line description of this node.

    maxFields

    Maximum number of fields that will be converted to strings. Any elements beyond the limit will be dropped.

    Definition Classes
    ExpressionTreeNode
  78. def simpleStringWithNodeId(): String

    ONE line description of this node containing the node identifier.

    ONE line description of this node containing the node identifier.

    Definition Classes
    ExpressionTreeNode
  79. def sql: String

    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
    Expression
  80. def stringArgs: Iterator[Any]

    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
  81. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  82. def third: Expression
    Definition Classes
    LeadTernaryLike
  83. def toJSON: String
    Definition Classes
    TreeNode
  84. def toString(): String
    Definition Classes
    FrameLessOffsetWindowFunctionExpressionTreeNode → AnyRef → Any
  85. def transform(rule: PartialFunction[Expression, Expression]): Expression

    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 used to transform this nodes children

    Definition Classes
    TreeNode
  86. def transformDown(rule: PartialFunction[Expression, Expression]): Expression

    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
  87. def transformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression

    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.

    cond

    a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.

    ruleId

    is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.

    rule

    the function used to transform this nodes children

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

    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 used to transform this nodes children

    Definition Classes
    TreeNode
  89. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression

    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.

    cond

    a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.

    ruleId

    is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.

    rule

    the function use to transform this node and its descendant nodes. The function takes a tuple as its input, where the first/second field is the before/after image of applying the rule on the node's children.

    Definition Classes
    TreeNode
  90. def transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression

    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.

    cond

    a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.

    ruleId

    is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.

    rule

    the function used to transform this nodes children

    Definition Classes
    TreeNode
  91. def transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression

    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.

    cond

    a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.

    ruleId

    is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.

    rule

    the function used to transform this nodes children

    Definition Classes
    TreeNode
  92. lazy val treePatternBits: BitSet

    A BitSet of tree patterns for this TreeNode and its subtree.

    A BitSet of tree patterns for this TreeNode and its subtree. If this TreeNode and its subtree contains a pattern P, the corresponding bit for P.id is set in this BitSet.

    Definition Classes
    TreeNodeTreePatternBits
  93. def treeString(append: (String) => Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  94. final def treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
    Definition Classes
    TreeNode
  95. final def treeString: String

    Returns a string representation of the nodes in this tree

    Returns a string representation of the nodes in this tree

    Definition Classes
    TreeNode
  96. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  97. final def verboseString(maxFields: Int): String

    ONE line description of this node with more information

    ONE line description of this node with more information

    Definition Classes
    ExpressionTreeNode
  98. def verboseStringWithSuffix(maxFields: Int): String

    ONE line description of this node with some suffix information

    ONE line description of this node with some suffix information

    Definition Classes
    TreeNode
  99. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  100. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  101. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  102. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  103. def withNewChildrenInternal(newFirst: Expression, newSecond: Expression, newThird: Expression): Lead
    Attributes
    protected
    Definition Classes
    LeadTernaryLike
  104. final def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    TernaryLike

Inherited from Serializable

Inherited from TernaryLike[Expression]

Inherited from ImplicitCastInputTypes

Inherited from ExpectsInputTypes

Inherited from Unevaluable

Inherited from OffsetWindowFunction

Inherited from WindowFunction

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped