org.apache.spark.sql.catalyst.expressions

AttributeReference

case class AttributeReference(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty)(exprId: ExprId = NamedExpression.newExprId, qualifiers: Seq[String] = Nil) extends Attribute with LeafNode[Expression] with Product with Serializable

A reference to an attribute produced by another operator in the tree.

name

The name of this attribute, should only be used during analysis or for debugging.

dataType

The DataType of this attribute.

nullable

True if null is a valid value for this attribute.

metadata

The metadata of this attribute.

exprId

A globally unique id used to check if different AttributeReferences refer to the same attribute.

qualifiers

a list of strings that can be used to referred to this attribute in a fully qualified way. Consider the examples tableName.name, subQueryAlias.name. tableName and subQueryAlias are possible qualifiers.

Linear Supertypes
Serializable, Serializable, Product, Equals, LeafNode[Expression], Attribute, NamedExpression, Expression, TreeNode[Expression], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AttributeReference
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. LeafNode
  7. Attribute
  8. NamedExpression
  9. Expression
  10. TreeNode
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AttributeReference(name: String, dataType: DataType, nullable: Boolean = true, metadata: Metadata = Metadata.empty)(exprId: ExprId = NamedExpression.newExprId, qualifiers: Seq[String] = Nil)

    name

    The name of this attribute, should only be used during analysis or for debugging.

    dataType

    The DataType of this attribute.

    nullable

    True if null is a valid value for this attribute.

    metadata

    The metadata of this attribute.

    exprId

    A globally unique id used to check if different AttributeReferences refer to the same attribute.

    qualifiers

    a list of strings that can be used to referred to this attribute in a fully qualified way. Consider the examples tableName.name, subQueryAlias.name. tableName and subQueryAlias are possible qualifiers.

Type Members

  1. abstract type EvaluatedType

    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
    Expression

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 children: Nil.type

    Definition Classes
    LeafNode
  9. 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
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. 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
  12. val dataType: DataType

    The DataType of this attribute.

    The DataType of this attribute.

    Definition Classes
    AttributeReferenceExpression
  13. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AttributeReference → Equals → AnyRef → Any
  15. def eval(input: Row = null): EvaluatedType

    Returns the result of evaluating this expression on a given input Row

    Returns the result of evaluating this expression on a given input Row

    Definition Classes
    AttributeReferenceExpression
  16. val exprId: ExprId

    A globally unique id used to check if different AttributeReferences refer to the same attribute.

    A globally unique id used to check if different AttributeReferences refer to the same attribute.

    Definition Classes
    AttributeReferenceNamedExpression
  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: (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
  20. 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
  21. 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
  22. 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
  23. 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
  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  25. def getNodeNumbered(number: trees.MutableInt): Expression

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

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

    Definition Classes
    Any
  28. def makeCopy(newArgs: Array[AnyRef]): AttributeReference.this.type

    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: (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
  30. def mapChildren(f: (Expression) ⇒ Expression): AttributeReference.this.type

    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. val metadata: Metadata

    The metadata of this attribute.

    The metadata of this attribute.

    Definition Classes
    AttributeReferenceNamedExpression
  32. val name: String

    The name of this attribute, should only be used during analysis or for debugging.

    The name of this attribute, should only be used during analysis or for debugging.

    Definition Classes
    AttributeReferenceNamedExpression
  33. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  34. def newInstance(): AttributeReference

    Definition Classes
    AttributeReferenceAttribute
  35. 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
  36. final def notify(): Unit

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

    Definition Classes
    AnyRef
  38. val nullable: Boolean

    True if null is a valid value for this attribute.

    True if null is a valid value for this attribute.

    Definition Classes
    AttributeReferenceExpression
  39. 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
  40. val origin: Origin

    Definition Classes
    TreeNode
  41. 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
  42. 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
  43. val qualifiers: Seq[String]

    a list of strings that can be used to referred to this attribute in a fully qualified way.

    a list of strings that can be used to referred to this attribute in a fully qualified way. Consider the examples tableName.name, subQueryAlias.name. tableName and subQueryAlias are possible qualifiers.

    Definition Classes
    AttributeReferenceNamedExpression
  44. def references: AttributeSet

    Definition Classes
    AttributeExpression
  45. 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
  46. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

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

    Definition Classes
    AnyRef
  49. def toAttribute: Attribute with Product

    Definition Classes
    AttributeNamedExpression
  50. def toString(): String

    Definition Classes
    AttributeReferenceTreeNode → AnyRef → Any
  51. 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
  52. def transformChildrenDown(rule: PartialFunction[Expression, Expression]): AttributeReference.this.type

    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
  53. def transformChildrenUp(rule: PartialFunction[Expression, Expression]): AttributeReference.this.type

    Definition Classes
    TreeNode
  54. 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
  55. 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
  56. 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
  57. def typeSuffix: String

    Attributes
    protected
    Definition Classes
    NamedExpression
  58. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. def withName(newName: String): AttributeReference

    Definition Classes
    AttributeReferenceAttribute
  62. def withNewChildren(newChildren: Seq[Expression]): AttributeReference.this.type

    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
  63. def withNullability(newNullability: Boolean): AttributeReference

    Returns a copy of this AttributeReference with changed nullability.

    Returns a copy of this AttributeReference with changed nullability.

    Definition Classes
    AttributeReferenceAttribute
  64. def withQualifiers(newQualifiers: Seq[String]): Attribute

    Returns a copy of this AttributeReference with new qualifiers.

    Returns a copy of this AttributeReference with new qualifiers.

    Definition Classes
    AttributeReferenceAttribute

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from LeafNode[Expression]

Inherited from Attribute

Inherited from NamedExpression

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from AnyRef

Inherited from Any

Ungrouped