trait Block extends TreeNode[Block] with JavaCode
A trait representing a block of java code.
- Alphabetic
- By Inheritance
- Block
- JavaCode
- TreeNode
- TreePatternBits
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def canEqual(that: Any): Boolean
- Definition Classes
- Equals
- abstract def children: Seq[Block]
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
- abstract def code: String
- Definition Classes
- JavaCode
- abstract def productArity: Int
- Definition Classes
- Product
- abstract def productElement(n: Int): Any
- Definition Classes
- Product
- abstract def withNewChildrenInternal(newChildren: IndexedSeq[Block]): Block
- Attributes
- protected
- Definition Classes
- TreeNode
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: Block): Block
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val _marginChar: Option[Char]
- 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
- 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
- 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.- Definition Classes
- TreeNode
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): Block
- Definition Classes
- TreeNode → AnyRef
- def collect[B](pf: PartialFunction[Block, 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
- def collectFirst[B](pf: PartialFunction[Block, 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
- def collectLeaves(): Seq[Block]
Returns a Seq containing the leaves in this tree.
Returns a Seq containing the leaves in this tree.
- Definition Classes
- TreeNode
- 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[_]]
- Definition Classes
- 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: Block): Unit
- Definition Classes
- TreeNode
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): 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
equalsmethods- Definition Classes
- TreeNode
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def find(f: (Block) => Boolean): Option[Block]
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
- def flatMap[A](f: (Block) => 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
- def foreach(f: (Block) => Unit): Unit
Runs the given function on this node and then recursively on children.
- def foreachUp(f: (Block) => Unit): Unit
Runs the given function recursively on children then on this node.
- 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.
- Definition Classes
- TreeNode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDefaultTreePatternBits: BitSet
Default tree pattern for a TreeNode.
Default tree pattern for a TreeNode.
- Attributes
- protected
- Definition Classes
- TreeNode
- def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
- Definition Classes
- TreeNode
- 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.
- Definition Classes
- TreeNode
- def isEmpty: Boolean
- 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
- Definition Classes
- TreeNode
- def jsonFields: List[JField]
- Attributes
- protected
- Definition Classes
- TreeNode
- final def legacyWithNewChildren(newChildren: Seq[Block]): Block
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
- def length: Int
- def makeCopy(newArgs: Array[AnyRef]): Block
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
- def map[A](f: (Block) => 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
- def mapChildren(f: (Block) => Block): Block
Returns a copy of this node where
fhas been applied to all the nodes inchildren.Returns a copy of this node where
fhas been applied to all the nodes inchildren.- Definition Classes
- TreeNode
- 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
- 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
- Definition Classes
- TreeNode
- 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.
- Definition Classes
- TreeNode
- 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
- def nonEmpty: Boolean
- 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).
- Definition Classes
- TreeNode
- val origin: Origin
- Definition Classes
- TreeNode
- 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
- def p(number: Int): Block
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
- def prettyJson: String
- Definition Classes
- TreeNode
- def productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- Product
- def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
- Definition Classes
- TreeNode
- 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
- TreeNode
- def simpleStringWithNodeId(): String
ONE line description of this node containing the node identifier.
- 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
- def stripMargin: Block.this.type
- def stripMargin(c: Char): Block.this.type
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toJSON: String
- Definition Classes
- TreeNode
- def toString(): String
- def transform(rule: PartialFunction[Block, Block]): Block
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
- Definition Classes
- TreeNode
- def transformDown(rule: PartialFunction[Block, Block]): Block
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
- Definition Classes
- TreeNode
- def transformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Block, Block]): Block
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
- Definition Classes
- TreeNode
- def transformExprValues(f: PartialFunction[ExprValue, ExprValue]): Block.this.type
Apply a map function to each java expression codes present in this java code, and return a new java code based on the mapped java expression codes.
- def transformUp(rule: PartialFunction[Block, Block]): Block
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
- Definition Classes
- TreeNode
- def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Block) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(Block, Block), Block]): Block
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.
- Definition Classes
- TreeNode
- def transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Block, Block]): Block
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
- Definition Classes
- TreeNode
- def transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Block, Block]): Block
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
- Definition Classes
- TreeNode
- 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
- Definition Classes
- TreeNode
- final def treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
- Definition Classes
- TreeNode
- 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
- def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
- Definition Classes
- TreeNode
- def verboseString(maxFields: Int): String
ONE line description of this node with more information
- 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
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def withNewChildren(newChildren: Seq[Block]): Block
- Definition Classes
- TreeNode