Packages

c

org.apache.spark.sql.expressions

MutableAggregationBuffer

abstract class MutableAggregationBuffer extends Row

A Row representing a mutable aggregation buffer.

This is not meant to be extended outside of Spark.

Annotations
@Stable()
Source
udaf.scala
Since

1.5.0

Linear Supertypes
Row, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableAggregationBuffer
  2. Row
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MutableAggregationBuffer()

Abstract Value Members

  1. abstract def copy(): Row

    Make a copy of the current Row object.

    Make a copy of the current Row object.

    Definition Classes
    Row
  2. abstract def get(i: Int): Any

    Returns the value at position i.

    Returns the value at position i. If the value is null, null is returned. The following is a mapping between Spark SQL types and return types:

    BooleanType -> java.lang.Boolean
    ByteType -> java.lang.Byte
    ShortType -> java.lang.Short
    IntegerType -> java.lang.Integer
    LongType -> java.lang.Long
    FloatType -> java.lang.Float
    DoubleType -> java.lang.Double
    StringType -> String
    DecimalType -> java.math.BigDecimal
    
    DateType -> java.sql.Date if spark.sql.datetime.java8API.enabled is false
    DateType -> java.time.LocalDate if spark.sql.datetime.java8API.enabled is true
    
    TimestampType -> java.sql.Timestamp if spark.sql.datetime.java8API.enabled is false
    TimestampType -> java.time.Instant if spark.sql.datetime.java8API.enabled is true
    
    BinaryType -> byte array
    ArrayType -> scala.collection.Seq (use getList for java.util.List)
    MapType -> scala.collection.Map (use getJavaMap for java.util.Map)
    StructType -> org.apache.spark.sql.Row
    Definition Classes
    Row
  3. abstract def length: Int

    Number of elements in the Row.

    Number of elements in the Row.

    Definition Classes
    Row
  4. abstract def update(i: Int, value: Any): Unit

    Update the ith value of this buffer.

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

    Returns true if there are any NULL values in this row.

    Returns true if there are any NULL values in this row.

    Definition Classes
    Row
  5. def apply(i: Int): Any

    Returns the value at position i.

    Returns the value at position i. If the value is null, null is returned. The following is a mapping between Spark SQL types and return types:

    BooleanType -> java.lang.Boolean
    ByteType -> java.lang.Byte
    ShortType -> java.lang.Short
    IntegerType -> java.lang.Integer
    LongType -> java.lang.Long
    FloatType -> java.lang.Float
    DoubleType -> java.lang.Double
    StringType -> String
    DecimalType -> java.math.BigDecimal
    
    DateType -> java.sql.Date if spark.sql.datetime.java8API.enabled is false
    DateType -> java.time.LocalDate if spark.sql.datetime.java8API.enabled is true
    
    TimestampType -> java.sql.Timestamp if spark.sql.datetime.java8API.enabled is false
    TimestampType -> java.time.Instant if spark.sql.datetime.java8API.enabled is true
    
    BinaryType -> byte array
    ArrayType -> scala.collection.Seq (use getList for java.util.List)
    MapType -> scala.collection.Map (use getJavaMap for java.util.Map)
    StructType -> org.apache.spark.sql.Row
    Definition Classes
    Row
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  10. def fieldIndex(name: String): Int

    Returns the index of a given field name.

    Returns the index of a given field name.

    Definition Classes
    Row
    Exceptions thrown

    IllegalArgumentException when a field name does not exist.

    UnsupportedOperationException when schema is not defined.

  11. def getAs[T](fieldName: String): T

    Returns the value of a given fieldName.

    Returns the value of a given fieldName. For primitive types if value is null it returns 'zero value' specific for primitive i.e. 0 for Int - use isNullAt to ensure that value is not null

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    IllegalArgumentException when fieldName do not exist.

    UnsupportedOperationException when schema is not defined.

  12. def getAs[T](i: Int): T

    Returns the value at position i.

    Returns the value at position i. For primitive types if value is null it returns 'zero value' specific for primitive i.e. 0 for Int - use isNullAt to ensure that value is not null

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  13. def getBoolean(i: Int): Boolean

    Returns the value at position i as a primitive boolean.

    Returns the value at position i as a primitive boolean.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  14. def getByte(i: Int): Byte

    Returns the value at position i as a primitive byte.

    Returns the value at position i as a primitive byte.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. def getDate(i: Int): Date

    Returns the value at position i of date type as java.sql.Date.

    Returns the value at position i of date type as java.sql.Date.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  17. def getDecimal(i: Int): BigDecimal

    Returns the value at position i of decimal type as java.math.BigDecimal.

    Returns the value at position i of decimal type as java.math.BigDecimal.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  18. def getDouble(i: Int): Double

    Returns the value at position i as a primitive double.

    Returns the value at position i as a primitive double.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  19. def getFloat(i: Int): Float

    Returns the value at position i as a primitive float.

    Returns the value at position i as a primitive float. Throws an exception if the type mismatches or if the value is null.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  20. def getInstant(i: Int): Instant

    Returns the value at position i of date type as java.time.Instant.

    Returns the value at position i of date type as java.time.Instant.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  21. def getInt(i: Int): Int

    Returns the value at position i as a primitive int.

    Returns the value at position i as a primitive int.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  22. def getJavaMap[K, V](i: Int): Map[K, V]

    Returns the value at position i of array type as a java.util.Map.

    Returns the value at position i of array type as a java.util.Map.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  23. def getList[T](i: Int): List[T]

    Returns the value at position i of array type as java.util.List.

    Returns the value at position i of array type as java.util.List.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  24. def getLocalDate(i: Int): LocalDate

    Returns the value at position i of date type as java.time.LocalDate.

    Returns the value at position i of date type as java.time.LocalDate.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  25. def getLong(i: Int): Long

    Returns the value at position i as a primitive long.

    Returns the value at position i as a primitive long.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  26. def getMap[K, V](i: Int): Map[K, V]

    Returns the value at position i of map type as a Scala Map.

    Returns the value at position i of map type as a Scala Map.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  27. def getSeq[T](i: Int): Seq[T]

    Returns the value at position i of array type as a Scala Seq.

    Returns the value at position i of array type as a Scala Seq.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  28. def getShort(i: Int): Short

    Returns the value at position i as a primitive short.

    Returns the value at position i as a primitive short.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    org.apache.spark.SparkRuntimeException when value is null.

  29. def getString(i: Int): String

    Returns the value at position i as a String object.

    Returns the value at position i as a String object.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  30. def getStruct(i: Int): Row

    Returns the value at position i of struct type as a Row object.

    Returns the value at position i of struct type as a Row object.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  31. def getTimestamp(i: Int): Timestamp

    Returns the value at position i of date type as java.sql.Timestamp.

    Returns the value at position i of date type as java.sql.Timestamp.

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

  32. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]

    Returns a Map consisting of names and values for the requested fieldNames For primitive types if value is null it returns 'zero value' specific for primitive i.e.

    Returns a Map consisting of names and values for the requested fieldNames For primitive types if value is null it returns 'zero value' specific for primitive i.e. 0 for Int - use isNullAt to ensure that value is not null

    Definition Classes
    Row
    Exceptions thrown

    ClassCastException when data type does not match.

    IllegalArgumentException when fieldName do not exist.

    UnsupportedOperationException when schema is not defined.

  33. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isNullAt(i: Int): Boolean

    Checks whether the value at position i is null.

    Checks whether the value at position i is null.

    Definition Classes
    Row
  36. def json: String

    The compact JSON representation of this row.

    The compact JSON representation of this row.

    Definition Classes
    Row
    Annotations
    @Unstable()
    Since

    3.0

  37. def mkString(start: String, sep: String, end: String): String

    Displays all elements of this traversable or iterator in a string using start, end, and separator strings.

    Displays all elements of this traversable or iterator in a string using start, end, and separator strings.

    Definition Classes
    Row
  38. def mkString(sep: String): String

    Displays all elements of this sequence in a string using a separator string.

    Displays all elements of this sequence in a string using a separator string.

    Definition Classes
    Row
  39. def mkString: String

    Displays all elements of this sequence in a string (without a separator).

    Displays all elements of this sequence in a string (without a separator).

    Definition Classes
    Row
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  43. def prettyJson: String

    The pretty (i.e.

    The pretty (i.e. indented) JSON representation of this row.

    Definition Classes
    Row
    Annotations
    @Unstable()
    Since

    3.0

  44. def schema: StructType

    Schema for the row.

    Schema for the row.

    Definition Classes
    Row
  45. def size: Int

    Number of elements in the Row.

    Number of elements in the Row.

    Definition Classes
    Row
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. def toSeq: Seq[Any]

    Return a Scala Seq representing the row.

    Return a Scala Seq representing the row. Elements are placed in the same order in the Seq.

    Definition Classes
    Row
  48. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Row

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped