HERE Data SDK - Scala API references < Back

Packages

package root

Definition Classes
root
package com

Definition Classes
root
package here

Definition Classes
com
package platform

Definition Classes
here
package data

Definition Classes
platform
package processing
This package provides the Data Processing Library for building distributed data processing applications.
This package provides the Data Processing Library for building distributed data processing applications.
A Runner both implements the interface with the environment for an application to run, and starts the application. The application, in turn, is driven by a Driver, that controls and performs the distributed processing.
Choose a Runner best suited for the environment where the application runs.
The Driver performs one of more tasks which read layers from input catalogs and write to one or more layers of an output catalog.
The main entry point in the processing library is the com.here.platform.data.processing.driver.DriverBuilder class where you can add different kinds of tasks to the driver. The driver runs the tasks, and commits the final results to the output catalog.
Tasks are implemented using one or more compilers.
The simplest compiler is the direct compiler which maps each input tile to N output tiles. The application needs to define com.here.platform.data.processing.compiler.Direct1ToNCompiler.
Other more complex compilation patterns are based on some kind of dependency tracking between input partitions and output partitions.
The processing Library supports the following patterns:
- com.here.platform.data.processing.compiler.NonIncrementalCompiler: non-incremental compilation only - com.here.platform.data.processing.compiler.DepCompiler: non-incremental dependency calculation and incremental compilation - com.here.platform.data.processing.compiler.IncrementalDepCompiler: incremental dependency calculation and compilation - com.here.platform.data.processing.compiler.Direct1ToNCompiler: incremental compilation where every output tile depends only on one input tile, and this mapping is independent from tile content - com.here.platform.data.processing.compiler.DirectMToNCompiler: incremental compilation where every output tile depends on multiple input tiles, and this mapping is independent from tile content - com.here.platform.data.processing.compiler.MapGroupCompiler: incremental compilation where every output tile can depend on multiple input tiles, and this mapping depend on the tile content - com.here.platform.data.processing.compiler.RefTreeCompiler: fully-managed two phases incremental compilation that can resolve references between input partitions. Input/Output dependency management is implemented and the developer doesn't need to provide this logic
The application's main object normally mixes in the a runner trait (like PipelineRunner) to setup the Driver, and interfaces with the environment where the application is run. See the Main classes in the example compilers for more details.
com.here.platform.data.processing.catalog, com.here.platform.data.processing.blobstore, and com.here.platform.data.processing.publisher contain utilities for accessing catalogs and payloads in a Spark-friendly way, providing an RDD-based abstraction over data and metadata. These classes are used by the processing library, but can also be used independently.

Definition Classes
data
package spark

Definition Classes
processing
package partitioner

Definition Classes
spark
AdapterPartitioner
AdaptiveLevelingPartitioner
HashPartitioner
KeyUnpackPartitioner
LocalityAwarePartitioner
NameHashPartitioner
PartitionNamePartitioner
Partitioner

com.here.platform.data.processing.spark.partitioner

LocalityAwarePartitioner

case class LocalityAwarePartitioner(numPartitions: Int, level: Int) extends PartitionNamePartitioner with Product with Serializable

Implements a Partitioner for com.here.platform.data.processing.catalog.Partition.Key that is aware of the geographic location of the keys and can therefore put keys that are close to each other in the same Spark partition. This increases the data locality and speeds up the processing of Spark worker nodes.

The partitioner detects which com.here.platform.data.processing.catalog.Partition.Keys are actually HereTiles: in this case keys are grouped at a fixed quadtree level, that is generally higher that the level of the keys (= lower number). Keys that are at a level even higher that the one specified, or keys that are not HERE tiles are partitioned using their hashcode and spread uniformly across all the available partitions. These partitions do not have data locality.

numPartitions: The overall number of partitions.
level: The level by which to group HereTiles in the same Spark partition.

Linear Supertypes

Product, Equals, PartitionNamePartitioner, Partitioner[KeyOrName], org.apache.spark.Partitioner, Serializable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

LocalityAwarePartitioner
Product
Equals
PartitionNamePartitioner
Partitioner
Partitioner
Serializable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new LocalityAwarePartitioner(numPartitions: Int, level: Int)
numPartitions
The overall number of partitions.
level
The level by which to group HereTiles in the same Spark partition.

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
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.
final def getPartitionForKey(key: KeyOrName): 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

Definition Classes
PartitionNamePartitioner → Partitioner
def getPartitionForName(name: Name): Int

Definition Classes
LocalityAwarePartitioner → PartitionNamePartitioner
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val level: Int
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val numPartitions: Int

Definition Classes
LocalityAwarePartitioner → Partitioner
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

LocalityAwarePartitioner

case class LocalityAwarePartitioner(numPartitions: Int, level: Int) extends PartitionNamePartitioner with Product with Serializable

Instance Constructors

Value Members

Inherited from Product

Inherited from Equals

Inherited from PartitionNamePartitioner

Inherited from Partitioner[KeyOrName]

Inherited from org.apache.spark.Partitioner

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

LocalityAwarePartitioner 

case class LocalityAwarePartitioner(numPartitions: Int, level: Int) extends PartitionNamePartitioner with Product with Serializable

Instance Constructors

Value Members

Inherited from Product

Inherited from Equals

Inherited from PartitionNamePartitioner

Inherited from Partitioner[KeyOrName]

Inherited from org.apache.spark.Partitioner

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

LocalityAwarePartitioner