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.

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 driver

Definition Classes: processing

package config

This package contains the configuration classes for all components of a Driver.

This package contains the configuration classes for all components of a Driver. Configuration is read from application.conf and provided to the developer as a com.here.platform.data.processing.driver.config.CompleteConfig instance, when the driver is setup.

Definition Classes: driver

CatalogConfig

CatalogsConfig

CompileInConfig

CompileOutConfig

CompleteConfig

DriverConfig

ExecutorConfig

ExecutorDebugConfig

PartitionKeyFilterConfig

RefTreeExecutorConfig

SparkStorageLevelsConfig

StateConfig

com.here.platform.data.processing.driver.config

CompileOutConfig

case class CompileOutConfig(threads: Int, sorting: Boolean) extends Product with Serializable

The configuration for the compileOut function.

threads: The number of parallel compileOut functions to execute per Spark task. This can be used to tune the CPU load/memory consumption of your compileOut implementations.
sorting: If true, compileOut executes over the Spark partitions sorted by partition key. In cases where compileOut retrieves additional payloads which are geographically close to the partition compileOut is producing, consider using a com.here.platform.data.processing.spark.partitioner.LocalityAwarePartitioner together with a cache for the additional content. This pattern improves performance and avoids retrieving and decoding the additional content multiple times. This parameter sorts the partition being produced by partition key, in this case locality, consequently improving the hit or miss ratio for the cache you implement in your code.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

CompileOutConfig
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new CompileOutConfig(threads: Int, sorting: Boolean)
threads
The number of parallel compileOut functions to execute per Spark task. This can be used to tune the CPU load/memory consumption of your compileOut implementations.
sorting
If true, compileOut executes over the Spark partitions sorted by partition key. In cases where compileOut retrieves additional payloads which are geographically close to the partition compileOut is producing, consider using a com.here.platform.data.processing.spark.partitioner.LocalityAwarePartitioner together with a cache for the additional content. This pattern improves performance and avoids retrieving and decoding the additional content multiple times. This parameter sorts the partition being produced by partition key, in this case locality, consequently improving the hit or miss ratio for the cache you implement in your code.

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()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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 sorting: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val threads: Int
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

CompileOutConfig

case class CompileOutConfig(threads: Int, sorting: Boolean) extends Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CompileOutConfig 

case class CompileOutConfig(threads: Int, sorting: Boolean) extends Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

CompileOutConfig