abstract class TreeNode[BaseType <: TreeNode[BaseType]] extends Product with TreePatternBits
- Self Type
- BaseType
- Alphabetic
- By Inheritance
- TreeNode
- TreePatternBits
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
simpleStringWithNodeId(): String
ONE line description of this node containing the node identifier.
-
abstract
def
verboseString(maxFields: Int): String
ONE line description of this node with more information
-
abstract
def
withNewChildrenInternal(newChildren: IndexedSeq[BaseType]): BaseType
- Attributes
- protected
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(maxFields: Int): String
Returns a string representing the arguments to this node, minus any children
-
def
asCode: String
Returns a 'scala code' representation of this
TreeNodeand its children.Returns a 'scala code' representation of this
TreeNodeand its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure'TreeNodesthat 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(): BaseType
- Definition Classes
- TreeNode → AnyRef
-
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.
-
final
def
containsAllPatterns(patterns: TreePattern*): Boolean
- returns
true if every bit for
patternsis set; false otherwise.
- Definition Classes
- TreePatternBits
-
final
def
containsAnyPattern(patterns: TreePattern*): Boolean
- returns
true if at least one bit for
patternsis set; false otherwise.
- Definition Classes
- TreePatternBits
- lazy val containsChild: Set[TreeNode[_]]
-
final
def
containsPattern(t: TreePattern): Boolean
- returns
true if the bit for
tis set; false otherwise.
- Definition Classes
- TreePatternBits
- Annotations
- @inline()
- def copyTagsFrom(other: BaseType): Unit
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exists(f: (BaseType) ⇒ Boolean): Boolean
Test whether there is TreeNode satisfies the conditions specified in
f.Test whether there is TreeNode satisfies the conditions specified in
f. The condition is recursively applied to this node and all of its children (pre-order). -
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
equalsmethods -
def
finalize(): Unit
- Attributes
- protected[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], 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 inlastChildrenindicates whether the ancestor of the current node at depthi + 1is the last child of its own parent node. The depth of the root node is 0, andlastChildrenfor 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
- Annotations
- @native()
-
def
getDefaultTreePatternBits: BitSet
Default tree pattern for a TreeNode.
Default tree pattern for a TreeNode.
- Attributes
- protected
- def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
-
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.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
ruleIdis UnknownId, it returns false.
- Attributes
- protected
-
def
jsonFields: List[JField]
- Attributes
- protected
-
final
def
legacyWithNewChildren(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.
- 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
fhas been applied to all the nodes inchildren. -
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
-
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
ruleIdis UnknownId, it is a no-op.
- 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.
-
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
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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 setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
-
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.
-
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
rulehas been recursively applied to the tree.Returns a copy of this node where
rulehas been recursively applied to the tree. Whenruledoes 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
-
def
transformDown(rule: PartialFunction[BaseType, BaseType]): BaseType
Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order). Whenruledoes not apply to a given node it is left unchanged.- rule
the function used to transform this nodes children
-
def
transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[BaseType, BaseType]): BaseType
Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order). Whenruledoes not apply to a given node it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) 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
-
def
transformUp(rule: PartialFunction[BaseType, BaseType]): BaseType
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- rule
the function used to transform this nodes children
-
def
transformUpWithBeforeAndAfterRuleOnChildren(cond: (BaseType) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(BaseType, BaseType), BaseType]): BaseType
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) 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.
-
def
transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[BaseType, BaseType]): BaseType
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) 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
-
def
transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[BaseType, BaseType]): BaseType
Returns a copy of this node where
rulehas been recursively applied to the tree.Returns a copy of this node where
rulehas been recursively applied to the tree. Whenruledoes 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.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) 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
-
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 forP.idis set in this BitSet.- Definition Classes
- TreeNode → TreePatternBits
- def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
- final def treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
-
final
def
treeString: String
Returns a string representation of the nodes in this tree
- def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
-
def
verboseStringWithSuffix(maxFields: Int): String
ONE line description of this node with some suffix information
-
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( ... ) @native()
- final def withNewChildren(newChildren: Seq[BaseType]): BaseType