org.apache.spark.sql.catalyst.trees

TreeNode

Related Doc: package trees

abstract class TreeNode[BaseType <: TreeNode[BaseType]] extends AnyRef

Self Type
BaseType with Product
Linear Supertypes
AnyRef, Any
Known Subclasses
Abs, Acos, Add, AddItemToSet, Aggregate, AggregateExpression, AggregateFunction, Alias, And, ApproxCountDistinct, ApproxCountDistinctMerge, ApproxCountDistinctMergeFunction, ApproxCountDistinctPartition, ApproxCountDistinctPartitionFunction, Asin, AtLeastNNonNulls, Atan, Atan2, Attribute, AttributeReference, Average, AverageFunction, BinaryArithmetic, BinaryComparison, BinaryExpression, BinaryMathExpression, BinaryNode, BitwiseAnd, BitwiseNot, BitwiseOr, BitwiseXor, BoundReference, CaseKeyWhen, CaseWhen, CaseWhenLike, Cast, Cbrt, Ceil, Coalesce, CollectHashSet, CollectHashSetFunction, CombineSets, CombineSetsAndCount, CombineSetsAndCountFunction, CombineSetsAndSum, CombineSetsAndSumFunction, CombineSum, CombineSumFunction, Contains, Cos, Cosh, Count, CountDistinct, CountDistinctFunction, CountFunction, CountSet, CreateArray, CreateStruct, Cube, Distinct, Divide, EndsWith, EqualNullSafe, EqualTo, Except, Exp, Expand, Explode, Expm1, Expression, ExtractValue, ExtractValueWithOrdinal, Filter, First, FirstFunction, Floor, Generate, Generator, GetArrayItem, GetArrayStructFields, GetMapValue, GetStructField, GreaterThan, GreaterThanOrEqual, GroupExpression, GroupingAnalytics, GroupingSets, HashPartitioning, Hypot, If, In, InSet, InsertIntoTable, Intersect, IsNotNull, IsNull, Join, Last, LastFunction, LeafExpression, LeafNode, LessThan, LessThanOrEqual, Like, Limit, Literal, LocalRelation, Log, Log10, Log1p, LogicalPlan, Lower, MakeDecimal, Max, MaxFunction, MaxOf, Min, MinFunction, MinOf, MultiAlias, Multiply, MutableLiteral, NamedExpression, NewSet, Not, OneRowRelation, Or, PartialAggregate, Pow, Predicate, PrettyAttribute, Project, QueryPlan, RDG, RLike, Rand, Randn, RangePartitioning, RedistributeData, Remainder, Repartition, RepartitionByExpression, ResolvedStar, Rint, Rollup, Sample, ScalaUdf, ScriptTransformation, Signum, Sin, Sinh, Sort, SortOrder, SortPartitions, Sqrt, Star, StartsWith, Subquery, Substring, Subtract, Sum, SumDistinct, SumDistinctFunction, SumFunction, Tan, Tanh, ToDegrees, ToRadians, UnaryExpression, UnaryMathExpression, UnaryMinus, UnaryNode, Union, UnresolvedAttribute, UnresolvedExtractValue, UnresolvedFunction, UnresolvedRelation, UnresolvedStar, UnresolvedWindowExpression, UnresolvedWindowFunction, UnscaledValue, Upper, UserDefinedGenerator, Window, WindowExpression, WindowFunction, WindowSpecDefinition, With, WithWindowDefinition, WriteToFile
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TreeNode
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TreeNode()

Abstract Value Members

  1. abstract def children: Seq[BaseType]

    Returns a Seq of the children of this node

Concrete 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): BaseType

    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.

  5. def argString: String

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

  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.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def collect[B](pf: PartialFunction[BaseType, 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.

  10. def collectFirst[B](pf: PartialFunction[BaseType, 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.

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

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

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def find(f: (BaseType) ⇒ Boolean): Option[BaseType]

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

  16. def flatMap[A](f: (BaseType) ⇒ 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.

  17. def foreach(f: (BaseType) ⇒ 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.

  18. def foreachUp(f: (BaseType) ⇒ 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.

  19. def generateTreeString(depth: Int, builder: StringBuilder): StringBuilder

    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.

    Attributes
    protected

  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  21. def getNodeNumbered(number: MutableInt): BaseType

    Attributes
    protected

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  24. def makeCopy(newArgs: Array[AnyRef]): TreeNode.this

    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.

  25. def map[A](f: (BaseType) ⇒ 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.

  26. def mapChildren(f: (BaseType) ⇒ BaseType): TreeNode.this

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

  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  28. def nodeName: String

    Returns the name of this type of TreeNode.

    Returns the name of this type of TreeNode. Defaults to the class name.

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

  32. val origin: Origin

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

    returns

    Attributes
    protected

  34. def simpleString: String

    String representation of this node without any children

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

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  37. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

  38. def transform(rule: PartialFunction[BaseType, BaseType]): BaseType

    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

  39. def transformChildrenDown(rule: PartialFunction[BaseType, BaseType]): TreeNode.this

    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

  40. def transformChildrenUp(rule: PartialFunction[BaseType, BaseType]): TreeNode.this

  41. def transformDown(rule: PartialFunction[BaseType, BaseType]): BaseType

    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

  42. def transformUp(rule: PartialFunction[BaseType, BaseType]): BaseType

    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

  43. def treeString: String

    Returns a string representation of the nodes in this tree

  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. def withNewChildren(newChildren: Seq[BaseType]): TreeNode.this

    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.

Inherited from AnyRef

Inherited from Any

Ungrouped