org.apache.spark.sql.catalyst.plans.logical

BinaryNode

abstract class BinaryNode extends LogicalPlan with trees.BinaryNode[LogicalPlan]

A logical plan node with a left and right child.

Self Type
BinaryNode with Product
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BinaryNode
  2. BinaryNode
  3. LogicalPlan
  4. QueryPlan
  5. TreeNode
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BinaryNode()

Abstract Value Members

  1. abstract def left: LogicalPlan

    Definition Classes
    BinaryNode
  2. abstract def output: Seq[Attribute]

    Definition Classes
    QueryPlan
  3. abstract def references: Set[Attribute]

    Returns the set of attributes that are referenced by this node during evaluation.

    Returns the set of attributes that are referenced by this node during evaluation.

    Definition Classes
    LogicalPlan
  4. abstract def right: LogicalPlan

    Definition Classes
    BinaryNode

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def apply(number: Int): LogicalPlan

    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.

    Definition Classes
    TreeNode
  7. def argString: 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. def children: Seq[LogicalPlan]

    Definition Classes
    BinaryNode
  11. def childrenResolved: Boolean

    Returns true if all its children of this query plan have been resolved.

    Returns true if all its children of this query plan have been resolved.

    Definition Classes
    LogicalPlan
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def collect[B](pf: PartialFunction[LogicalPlan, 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
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def expressions: Seq[Expression]

    Returns all of the expressions present in this query plan operator.

    Returns all of the expressions present in this query plan operator.

    Definition Classes
    QueryPlan
  17. 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 from generating case class equals methods

    Definition Classes
    TreeNode
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def flatMap[A](f: (LogicalPlan) ⇒ 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
  20. def foreach(f: (LogicalPlan) ⇒ 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
  21. 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
    Definition Classes
    TreeNode
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def getNodeNumbered(number: MutableInt): LogicalPlan

    Attributes
    protected
    Definition Classes
    TreeNode
  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  25. val id: Long

    A globally unique id for this specific instance.

    A globally unique id for this specific instance. Not preserved across copies. Unlike equals, id can be used to differentiate distinct but structurally identical branches of a tree.

    Definition Classes
    TreeNode
  26. lazy val inputSet: Set[Attribute]

    Returns the set of attributes that this node takes as input from its children.

    Returns the set of attributes that this node takes as input from its children.

    Definition Classes
    LogicalPlan
  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. def makeCopy(newArgs: Array[AnyRef]): BinaryNode.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.

    Definition Classes
    TreeNode
  29. def map[A](f: (LogicalPlan) ⇒ 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
  30. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): BinaryNode.this

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

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

    Definition Classes
    TreeNode
  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  32. def nodeName: String

    Returns the name of this type of TreeNode.

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

    Definition Classes
    TreeNode
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. 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.

    Definition Classes
    TreeNode
  36. 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
    Definition Classes
    TreeNode
  37. def outputSet: Set[Attribute]

    Returns the set of attributes that are output by this node.

    Returns the set of attributes that are output by this node.

    Definition Classes
    QueryPlan
  38. def resolve(name: String): Option[NamedExpression]

    Optionally resolves the given string to a NamedExpression.

    Optionally resolves the given string to a NamedExpression. The attribute is expressed as as string in the following form: [scope].AttributeName.[nested].[fields]....

    Definition Classes
    LogicalPlan
  39. lazy val resolved: Boolean

    Returns true if this expression and all its children have been resolved to a specific schema and false if it is still contains any unresolved placeholders.

    Returns true if this expression and all its children have been resolved to a specific schema and false if it is still contains any unresolved placeholders. Implementations of LogicalPlan can override this (e.g. UnresolvedRelation should return false).

    Definition Classes
    LogicalPlan
  40. def sameInstance(other: TreeNode[_]): Boolean

    Returns true if other is the same TreeNode instance.

    Returns true if other is the same TreeNode instance. Unlike equals this function will return false for different instances of structurally identical trees.

    Definition Classes
    TreeNode
  41. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    TreeNode
  42. 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
  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  44. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any
  45. def transform(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    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
  46. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): BinaryNode.this

    Returns the result of running transformExpressions on this node and all its children.

    Returns the result of running transformExpressions on this node and all its children.

    Definition Classes
    QueryPlan
  47. def transformChildrenDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): BinaryNode.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

    Definition Classes
    TreeNode
  48. def transformChildrenUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): BinaryNode.this

    Definition Classes
    TreeNode
  49. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    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
  50. def transformExpressions(rule: PartialFunction[Expression, Expression]): BinaryNode.this

    Runs transform with rule on all expressions present in this query operator.

    Runs transform with rule on all expressions present in this query operator. Users should not expect a specific directionality. If a specific directionality is needed, transformExpressionsDown or transformExpressionsUp should be used.

    rule

    the rule to be applied to every expression in this operator.

    Definition Classes
    QueryPlan
  51. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): BinaryNode.this

    Runs transformDown with rule on all expressions present in this query operator.

    Runs transformDown with rule on all expressions present in this query operator.

    rule

    the rule to be applied to every expression in this operator.

    Definition Classes
    QueryPlan
  52. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): BinaryNode.this

    Runs transformUp with rule on all expressions present in this query operator.

    Runs transformUp with rule on all expressions present in this query operator.

    rule

    the rule to be applied to every expression in this operator.

    returns

    Definition Classes
    QueryPlan
  53. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    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
  54. 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
  55. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def withNewChildren(newChildren: Seq[LogicalPlan]): BinaryNode.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.

    Definition Classes
    TreeNode

Inherited from trees.BinaryNode[LogicalPlan]

Inherited from LogicalPlan

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from AnyRef

Inherited from Any

Ungrouped