org.apache.spark.sql.catalyst.expressions

Generator

abstract class Generator extends Expression

An expression that produces zero or more rows given a single input row.

Generators produce multiple output rows instead of a single value like other expressions, and thus they must have a schema to associate with the rows that are output.

However, unlike row producing relational operators, which are either leaves or determine their output schema functionally from their input, generators can contain other expressions that might result in their modification by rules. This structure means that they might be copied multiple times after first determining their output schema. If a new output schema is created for each copy references up the tree might be rendered invalid. As a result generators must instead define a function makeOutput which is called only once when the schema is first requested. The attributes produced by this function will be automatically copied anytime rules result in changes to the Generator or its children.

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

Instance Constructors

  1. new Generator()

Type Members

  1. type EvaluatedType = TraversableOnce[Row]

    The narrowest possible type that is produced when this expression is evaluated.

    The narrowest possible type that is produced when this expression is evaluated.

    Definition Classes
    GeneratorExpression

Abstract Value Members

  1. abstract def children: Seq[Expression]

    Returns a Seq of the children of this node

    Returns a Seq of the children of this node

    Definition Classes
    TreeNode
  2. abstract def eval(input: Row): TraversableOnce[Row]

    Should be implemented by child classes to perform specific Generators.

    Should be implemented by child classes to perform specific Generators.

    Definition Classes
    GeneratorExpression
  3. abstract def makeOutput(): Seq[Attribute]

    Should be overridden by specific generators.

    Should be overridden by specific generators. Called only once for each instance to ensure that rule application does not change the output schema of a generator.

    Attributes
    protected

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): Expression

    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 childrenResolved: Boolean

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

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

    Definition Classes
    Expression
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def collect[B](pf: PartialFunction[Expression, 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
  11. lazy val dataType: ArrayType

    Returns the DataType of the result of evaluating this expression.

    Returns the DataType of the result of evaluating this expression. It is invalid to query the dataType of an unresolved expression (i.e., when resolved == false).

    Definition Classes
    GeneratorExpression
  12. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def flatMap[A](f: (Expression) ⇒ 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
  17. def foldable: Boolean

    Returns true when an expression is a candidate for static evaluation before the query is executed.

    Returns true when an expression is a candidate for static evaluation before the query is executed.

    The following conditions are used to determine suitability for constant folding:

    Definition Classes
    Expression
  18. def foreach(f: (Expression) ⇒ 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
  19. def foreachUp(f: (Expression) ⇒ 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
  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: trees.MutableInt): Expression

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

    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. def makeCopy(newArgs: Array[AnyRef]): Generator.this

    Overridden makeCopy also copies the attributes that are produced by this generator.

    Overridden makeCopy also copies the attributes that are produced by this generator.

    newArgs

    the new product arguments.

    Definition Classes
    GeneratorTreeNode
  26. def map[A](f: (Expression) ⇒ 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
  27. def mapChildren(f: (Expression) ⇒ Expression): Generator.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
  28. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  32. def nullable: Boolean

    Definition Classes
    GeneratorExpression
  33. 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
  34. val origin: Origin

    Definition Classes
    TreeNode
  35. 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
  36. def output: Seq[Attribute]

  37. def prettyString: String

    Returns a string representation of this expression that does not have developer centric debugging information like the expression id.

    Returns a string representation of this expression that does not have developer centric debugging information like the expression id.

    Definition Classes
    Expression
  38. def references: AttributeSet

    Definition Classes
    Expression
  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 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 expressions should override this if the resolution of this type of expression involves more than just the resolution of its children.

    Definition Classes
    Expression
  40. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

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

    Definition Classes
    AnyRef
  43. def toString(): String

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

    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
  45. def transformChildrenDown(rule: PartialFunction[Expression, Expression]): Generator.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
  46. def transformChildrenUp(rule: PartialFunction[Expression, Expression]): Generator.this

    Definition Classes
    TreeNode
  47. def transformDown(rule: PartialFunction[Expression, Expression]): Expression

    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
  48. def transformUp(rule: PartialFunction[Expression, Expression]): Expression

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

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

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

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

Inherited from TreeNode[Expression]

Inherited from AnyRef

Inherited from Any

Ungrouped