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

LeafNode

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

A logical plan node with no children.

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

Instance Constructors

  1. new LeafNode()

Abstract Value Members

  1. abstract def output: Seq[Attribute]

    Definition Classes
    QueryPlan

Concrete Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. 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
  5. 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
  6. 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
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def children: Nil.type

    Definition Classes
    LeafNode
  9. 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
  10. lazy val cleanArgs: Seq[Any]

    Args that have cleaned such that differences in expression id should not affect equality

    Args that have cleaned such that differences in expression id should not affect equality

    Attributes
    protected
    Definition Classes
    LogicalPlan
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. 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
  13. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. 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
  19. 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
  20. 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
  21. final def getClass(): Class[_]

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

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

    Definition Classes
    AnyRef → Any
  24. def inputSet: AttributeSet

    The set of all attributes that are input to this operator by its children.

    The set of all attributes that are input to this operator by its children.

    Definition Classes
    QueryPlan
  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging
  27. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging
  28. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  29. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  30. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  31. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  32. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  33. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  34. def logName: String

    Attributes
    protected
    Definition Classes
    Logging
  35. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  36. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  37. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  38. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  39. def makeCopy(newArgs: Array[AnyRef]): LeafNode.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
  40. 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
  41. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): LeafNode.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
  42. def missingInput: AttributeSet

    Attributes that are referenced by expressions but not provided by this nodes children.

    Attributes that are referenced by expressions but not provided by this nodes children. Subclasses should override this method if they produce attributes internally as it is used by assertions designed to prevent the construction of invalid plans.

    Definition Classes
    QueryPlan
  43. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  47. 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
  48. 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
  49. def outputSet: AttributeSet

    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
  50. def printSchema(): Unit

    Prints out the schema in the tree format

    Prints out the schema in the tree format

    Definition Classes
    QueryPlan
  51. def references: AttributeSet

    All Attributes that appear in expressions from this operator.

    All Attributes that appear in expressions from this operator. Note that this set does not include attributes that are implicitly referenced by being passed through to the output tuple.

    Definition Classes
    QueryPlan
  52. def resolve(name: String, input: Seq[Attribute], resolver: Resolver): Option[NamedExpression]

    Performs attribute resolution given a name and a sequence of possible attributes.

    Performs attribute resolution given a name and a sequence of possible attributes.

    Attributes
    protected
    Definition Classes
    LogicalPlan
  53. def resolve(name: String, resolver: Resolver): Option[NamedExpression]

    Optionally resolves the given string to a NamedExpression based on the output of this LogicalPlan.

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

    Definition Classes
    LogicalPlan
  54. def resolveChildren(name: String, resolver: Resolver): Option[NamedExpression]

    Optionally resolves the given string to a NamedExpression using the input from all child nodes of this LogicalPlan.

    Optionally resolves the given string to a NamedExpression using the input from all child nodes of this LogicalPlan. The attribute is expressed as as string in the following form: [scope].AttributeName.[nested].[fields]....

    Definition Classes
    LogicalPlan
  55. lazy val resolved: Boolean

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

    Definition Classes
    LogicalPlan
  56. def sameResult(plan: LogicalPlan): Boolean

    Returns true when the given logical plan will return the same results as this logical plan.

    Returns true when the given logical plan will return the same results as this logical plan.

    Since its likely undecideable to generally determine if two given plans will produce the same results, it is okay for this function to return false, even if the results are actually the same. Such behavior will not affect correctness, only the application of performance enhancements like caching. However, it is not acceptable to return true if the results could possibly be different.

    By default this function performs a modified version of equality that is tolerant of cosmetic differences like attribute naming and or expression id differences. Logical operators that can do better should override this function.

    Definition Classes
    LogicalPlan
  57. def schema: StructType

    Definition Classes
    QueryPlan
  58. def schemaString: String

    Returns the output schema in the tree format.

    Returns the output schema in the tree format.

    Definition Classes
    QueryPlan
  59. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    QueryPlanTreeNode
  60. def statePrefix: String

    Attributes
    protected
    Definition Classes
    LogicalPlanQueryPlan
  61. def statistics: Statistics

    Definition Classes
    LogicalPlan
  62. 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
  63. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  64. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any
  65. 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
  66. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): LeafNode.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
  67. def transformChildrenDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LeafNode.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
  68. def transformChildrenUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LeafNode.this

    Definition Classes
    TreeNode
  69. 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
  70. def transformExpressions(rule: PartialFunction[Expression, Expression]): LeafNode.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
  71. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): LeafNode.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
  72. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): LeafNode.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
  73. 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
  74. 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
  75. final def wait(): Unit

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

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

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

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from AnyRef

Inherited from Any

Ungrouped