TreeNode

Instance Constructors

new TreeNode()

Abstract Value Members

abstract def canEqual(that: Any): Boolean

Definition Classes
Equals
abstract def children: Seq[BaseType]

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
abstract def productArity: Int

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

Definition Classes
Product
abstract def verboseString: String

ONE line description of this node with more information

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
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.
def argString: String

Returns a string representing the arguments to this node, minus any children
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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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.
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.
def collectLeaves(): Seq[BaseType]

Returns a Seq containing the leaves in this tree.
lazy val containsChild: Set[TreeNode[_]]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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).
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.
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.
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.
def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String = ""): 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.
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.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
TreeNode → AnyRef → Any
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.

Attributes
protected
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def jsonFields: List[JField]

Attributes
protected
def makeCopy(newArgs: Array[AnyRef]): BaseType

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

Returns a copy of this node where f has been applied to all the nodes children.
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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).
val origin: Origin
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
def p(number: Int): BaseType

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).
def prettyJson: String
def productIterator: Iterator[Any]

Definition Classes
Product
def productPrefix: String

Definition Classes
Product
def simpleString: String

ONE line description of this node.
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toJSON: String
def toString(): String

Definition Classes
TreeNode → AnyRef → Any
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
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
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
def treeString(verbose: Boolean): String
def treeString: String

Returns a string representation of the nodes in this tree
final def wait(): Unit

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

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

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

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.

Related Doc: package trees

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

Instance Constructors

new TreeNode()

Abstract Value Members

abstract def canEqual(that: Any): Boolean

abstract def children: Seq[BaseType]

abstract def productArity: Int

abstract def productElement(n: Int): Any

abstract def verboseString: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply(number: Int): TreeNode[_]

def argString: String

def asCode: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def collect[B](pf: PartialFunction[BaseType, B]): Seq[B]

def collectFirst[B](pf: PartialFunction[BaseType, B]): Option[B]

def collectLeaves(): Seq[BaseType]

lazy val containsChild: Set[TreeNode[_]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fastEquals(other: TreeNode[_]): Boolean

def finalize(): Unit

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

def flatMap[A](f: (BaseType) ⇒ TraversableOnce[A]): Seq[A]

def foreach(f: (BaseType) ⇒ Unit): Unit

def foreachUp(f: (BaseType) ⇒ Unit): Unit

def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String = ""): StringBuilder

final def getClass(): Class[_]

def hashCode(): Int

def innerChildren: Seq[TreeNode[_]]

final def isInstanceOf[T0]: Boolean

def jsonFields: List[JField]

def makeCopy(newArgs: Array[AnyRef]): BaseType

def map[A](f: (BaseType) ⇒ A): Seq[A]

def mapChildren(f: (BaseType) ⇒ BaseType): BaseType

def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

final def ne(arg0: AnyRef): Boolean

def nodeName: String

final def notify(): Unit

final def notifyAll(): Unit

def numberedTreeString: String

val origin: Origin

def otherCopyArgs: Seq[AnyRef]

def p(number: Int): BaseType

def prettyJson: String

def productIterator: Iterator[Any]

def productPrefix: String

def simpleString: String

def stringArgs: Iterator[Any]

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

def toJSON: String

def toString(): String

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

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

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

def treeString(verbose: Boolean): String

def treeString: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withNewChildren(newChildren: Seq[BaseType]): BaseType

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped