Packages

abstract class Partitioner[-K] extends org.apache.spark.Partitioner

Abstract class implementing a type-safe Spark partitioner. This class is usually employed in interfaces of the processing library to better specify the kind of partitioner needed; compiler developers must provide this class.

A Partitioner is also a Spark org.apache.spark.Partitioner, but the function that has to be implemented to provide the code requires the key of type K instead of the scala.Any required by the Spark org.apache.spark.Partitioner.

equals and hashCode methods must be implemented properly otherwise Spark may introduce unnecessary shuffle operations or assertions in the data processing algorithms may fail.

K

the type of the keys

Linear Supertypes
org.apache.spark.Partitioner, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Partitioner
  2. Partitioner
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Partitioner()(implicit arg0: ClassTag[K])

Abstract Value Members

  1. abstract def getPartitionForKey(key: K): Int

    Gets the partition for a given key of type K.

    Gets the partition for a given key of type K. This is the function that must be implemented by children partitioners.

    key

    the key for which the partition must be calculated

    returns

    the partition, identified by one scala.Int, in which the key should be located

  2. abstract def numPartitions: Int
    Definition Classes
    Partitioner

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def getPartition(key: Any): Int

    Implements the Spark org.apache.spark.Partitioner interface by forwarding the calls to getPartitionForKey.

    Implements the Spark org.apache.spark.Partitioner interface by forwarding the calls to getPartitionForKey.

    If the object passed is not of type K or can't be converted to it (e.g. java.lang.Integer to Int), a IllegalArgumentException is thrown. This should be considered a bug that should not happen because the processing library uses Partitioner of type K only for RDDs for which it is aware and sure to have keys of type K.

    Basically, this function is a no-op call that forwards to getPartitionForKey, but the important point here is to have a type-safe Partitioner in the processing library.

    key

    the key for which the partition must be calculated

    returns

    the partition, identified by one scala.Int, in which the key should be located

    Definition Classes
    Partitioner → Partitioner
    Note

    This is called by Spark and should not be called by developer's code, as it may be unsafe.

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from org.apache.spark.Partitioner

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped