Packages

case class CodeBlock(codeParts: Seq[String], blockInputs: Seq[JavaCode]) extends TreeNode[Block] with Block with Product with Serializable

A block of java code. Including a sequence of code parts and some inputs to this block. The actual java code is generated by embedding the inputs into the code parts. Here we keep inputs of JavaCode instead of simply folding them as a string of code, because we need to track expressions (ExprValue) in this code block. We need to be able to manipulate the expressions later without changing the behavior of this code block in some applications, e.g., method splitting.

Linear Supertypes
Serializable, Serializable, Block, JavaCode, TreeNode[Block], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CodeBlock
  2. Serializable
  3. Serializable
  4. Block
  5. JavaCode
  6. TreeNode
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CodeBlock(codeParts: Seq[String], blockInputs: Seq[JavaCode])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: Block): Block
    Definition Classes
    Block
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val _marginChar: Option[Char]
    Definition Classes
    Block
  6. 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
  7. 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
  8. 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val blockInputs: Seq[JavaCode]
  11. 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
    CodeBlockTreeNode
  12. def clone(): Block
    Definition Classes
    TreeNode → AnyRef
  13. lazy val code: String
    Definition Classes
    CodeBlockJavaCode
  14. val codeParts: Seq[String]
  15. 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
  16. 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
  17. 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
  18. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  19. def copyTagsFrom(other: Block): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. 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
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. 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
  24. 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
  25. def foreach(f: (Block) ⇒ 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
  26. def foreachUp(f: (Block) ⇒ 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
  27. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String = "", addSuffix: Boolean = false, maxFields: Int, printNodeId: Boolean): 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
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  30. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  31. 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
  32. def isEmpty: Boolean
    Definition Classes
    Block
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  35. def length: Int
    Definition Classes
    Block
  36. 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
  37. 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
  38. def mapChildren(f: (Block) ⇒ Block): Block

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

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

    Definition Classes
    TreeNode
  39. 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
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. 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
  42. def nonEmpty: Boolean
    Definition Classes
    Block
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. 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
  46. val origin: Origin
    Definition Classes
    TreeNode
  47. 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
  48. 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
  49. def prettyJson: String
    Definition Classes
    TreeNode
  50. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  51. 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
  52. 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
    BlockTreeNode
  53. 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
  54. def stripMargin: CodeBlock.this.type
    Definition Classes
    Block
  55. def stripMargin(c: Char): CodeBlock.this.type
    Definition Classes
    Block
  56. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  57. def toJSON: String
    Definition Classes
    TreeNode
  58. def toString(): String
    Definition Classes
    BlockJavaCodeTreeNode → AnyRef → Any
  59. def transform(rule: PartialFunction[Block, Block]): Block

    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

    Definition Classes
    TreeNode
  60. def transformDown(rule: PartialFunction[Block, Block]): Block

    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
  61. def transformExprValues(f: PartialFunction[ExprValue, ExprValue]): CodeBlock.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.

    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.

    Definition Classes
    Block
  62. def transformUp(rule: PartialFunction[Block, Block]): Block

    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

    Definition Classes
    TreeNode
  63. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  64. final def treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
    Definition Classes
    TreeNode
  65. 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
  66. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  67. 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
    BlockTreeNode
  68. 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
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  72. def withNewChildren(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.

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from Block

Inherited from JavaCode

Inherited from TreeNode[Block]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped