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 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
package deltasets

Definition Classes
driver
package filter

Definition Classes
driver
package impl

Definition Classes
driver
package job

Definition Classes
driver
package modes

Definition Classes
driver
package runner

Definition Classes
driver
Default
DeltaDriverTask
DeltaDriverTaskBuilder
DeltaSetup
DeltaSimpleSetup
Driver
DriverBuilder
DriverContext
DriverSetup
DriverSetupManual
DriverSetupWithBuilder
DriverTask
Executor
Fingerprints
IncrementalCompilerExecutor
MultiCompilerTaskBuilder
MultiModeDriverTask
NonIncrementalCompilerExecutor
PartitionKeyFiltering
StatefulCompilerExecutor
TaskBuilder
TaskResult

com.here.platform.data.processing.driver

Executor

Companion object Executor

sealed trait Executor extends InputLayers with InputPartitioner with OutputLayers with OutputPartitioner

Base class for all the executors.

Executors work at RDD level, meaning that RDDs are passed and returned to the functions that each executor implements. It is important to define a common policy regarding the persistence of RDDs that are passed and returned. Not respecting this policy introduces a risk of Spark throwing an exception due to the fact that some RDDs may be persisted twice with different storage levels. This policy may be applicable to classes other than executors, such as com.here.platform.data.processing.compiler.NonIncrementalCompiler, com.here.platform.data.processing.compiler.DepCompilerBase and derived.

Note: The policy established is as follows: RDDs passed to every execute function are guaranteed to be reusable multiple times, efficiently, without the need for the implementations to persist them. Implementations shall not persist passed RDDs. These are either already persisted by the processing library or guaranteed to be reusable multiple time efficiently. Therefore, implementations shall not require() or assert() that passed RDDs are persisted, although it's guaranteed that they will be, or equivalent. RDDs returned by every execute function don't have to be persisted. They may be persisted if it's useful to the implementations. The processing library may persist the RDDs once returned, if not already persisted.

Linear Supertypes

OutputPartitioner, OutputLayers, InputPartitioner, InputLayers, AnyRef, Any

Known Subclasses

IncrementalCompilerExecutor, NonIncrementalCompilerExecutor, StatefulCompilerExecutor, DepCompilerBaseExecutor, DepCompilerExecutor, Direct1ToNCompilerExecutor, DirectMToNCompilerExecutor, IncrementalDepCompilerExecutor, NonIncrementalExecutor, RefTreeCompilerExecutor

Ordering

Alphabetic
By Inheritance

Inherited

Executor
OutputPartitioner
OutputLayers
InputPartitioner
InputLayers
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def id: Id
Unique identifier of the com.here.platform.data.processing.driver.Executor.
abstract def inLayers: Map[Id, Set[Id]]
Represents layers of the input catalogs that you should query and provide to the compiler.
Represents layers of the input catalogs that you should query and provide to the compiler. These layers are grouped by input catalog and identified by catalog ID and layer ID.

Definition Classes
InputLayers
abstract def inPartitioner(parallelism: Int): Partitioner[InKey]
Specifies the partitioner to use when querying the input catalogs.
Specifies the partitioner to use when querying the input catalogs.
parallelism
The number of partitions the partitioner should partition the catalog into, this should match the parallelism of the Spark RDD containing the input partitions.
returns
The input partitioner with the parallelism specified.

Definition Classes
InputPartitioner
abstract def outLayers: Set[Id]
Layers to be produced by the compiler.
Layers to be produced by the compiler.

Definition Classes
OutputLayers
abstract def outPartitioner(parallelism: Int): Partitioner[OutKey]
Specifies the partitioner to use when querying the output catalog and producing output data.
Specifies the partitioner to use when querying the output catalog and producing output data.
parallelism
The number of partitions the partitioner should partition the catalog into, this should match the parallelism of the Spark RDD containing the output partitions.
returns
The output partitioner with the parallelism specified.

Definition Classes
OutputPartitioner

Concrete 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 equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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 hashCode(): Int

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()
final val outCatalogId: Id
Identifier for the output catalog.
Identifier for the output catalog.

Definition Classes
OutputLayers
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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

Executor

Companion object Executor

sealed trait Executor extends InputLayers with InputPartitioner with OutputLayers with OutputPartitioner

Abstract Value Members

Concrete Value Members

Inherited from OutputPartitioner

Inherited from OutputLayers

Inherited from InputPartitioner

Inherited from InputLayers

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Executor 

Companion object Executor

sealed trait Executor extends InputLayers with InputPartitioner with OutputLayers with OutputPartitioner

Abstract Value Members

Concrete Value Members

Inherited from OutputPartitioner

Inherited from OutputLayers

Inherited from InputPartitioner

Inherited from InputLayers

Inherited from AnyRef

Inherited from Any

Ungrouped

Executor