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 compiler

Definition Classes
processing
package direct

Definition Classes
compiler
package mapgroup

Definition Classes
compiler
package reftree

Definition Classes
compiler
CompileOut1To1Fn
CompileOut1ToNFn
CompileOutFn
CompileOutLayerStackFn
DepCompiler
DepCompilerBase
Direct1ToNCompiler
DirectMToNCompiler
IncrementalDepCompiler
InputLayers
InputOptPartitioner
InputPartitioner
MapGroupCompiler
NonIncrementalCompiler
OutputLayers
OutputOptPartitioner
OutputPartitioner
RefTreeCompiler

com.here.platform.data.processing.compiler

CompileOutLayerStackFn

trait CompileOutLayerStackFn[T] extends CompileOut1ToNFn[T]

Produces multiple layers, each with its com.here.platform.data.processing.blobstore.Payload, for each "nominal" output partition the compiler generates.

T: the custom type of the values passed between front-end and back-end

Linear Supertypes

CompileOut1ToNFn[T], CompileOutFn[T], Serializable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

CompileOutLayerStackFn
CompileOut1ToNFn
CompileOutFn
Serializable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def compileOutFn(outKey: OutKey, intermediate: Iterable[T]): Map[OutKey, Payload]
Compiles a single output partition.
Compiles a single output partition.
outKey
the key of the output partition to generate
intermediate
non-empty scala.Iterable of intermediate data as provided by compileInFn which is required to compile the output partition. This collection will have multiple entries of the same value in case the same value was returned for this outKey by multiple compileInFn executions (for different input keys). outKeys which do not have any intermediate values assigned from the compileInFn calls get deleted automatically.
returns
output keys and their com.here.platform.data.processing.blobstore.Payload for each partition that contains data. Any old data for keys returned by compileOutMapping but not returned here will be automatically deleted from the catalog.

Definition Classes
CompileOut1ToNFn
abstract def compileOutLayerMapping: Map[Id, Set[Id]]
Map that defines which additional layers will be generated in the compile out function for every key of the given layer.
Map that defines which additional layers will be generated in the compile out function for every key of the given layer. The keys of the additional layer(s) will have the same partition name as the keys in the intermediate data.
abstract def preservesPartitioning: Boolean
Defines if all output keys generated by compileOutMapping are in the same Spark partition as the input parameter outKey.
Defines if all output keys generated by compileOutMapping are in the same Spark partition as the input parameter outKey. This can be guaranteed by using a com.here.platform.data.processing.spark.partitioner.PartitionNamePartitioner and in this case true should be returned
When this is set to true the result of compileOutFn will not be repartitioned, allowing a common stage with the upload functionality of the driver task.

Definition Classes
CompileOut1ToNFn

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 compileOutFnDefined(): Unit
Must be overridden as final by all subclasses, to block the mixin of different interfaces in the same compiler class and to assure that at least one child interface is mixed in.
Must be overridden as final by all subclasses, to block the mixin of different interfaces in the same compiler class and to assure that at least one child interface is mixed in.

Attributes
protected
Definition Classes
CompileOut1ToNFn → CompileOutFn
final def compileOutMapping(outKey: OutKey): Set[OutKey]
Defines which output keys the compile out function will generate for a given output key of the intermediate data.
Defines which output keys the compile out function will generate for a given output key of the intermediate data.
outKey
the output key in the intermediate data
returns
Set of output keys that will be generated. Usually should contain outKey as well, unless the compileOutFn will not generate output with that key.

Definition Classes
CompileOutLayerStackFn → CompileOut1ToNFn
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 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

CompileOutLayerStackFn

trait CompileOutLayerStackFn[T] extends CompileOut1ToNFn[T]

Abstract Value Members

Concrete Value Members

Inherited from CompileOut1ToNFn[T]

Inherited from CompileOutFn[T]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CompileOutLayerStackFn 

trait CompileOutLayerStackFn[T] extends CompileOut1ToNFn[T]

Abstract Value Members

Concrete Value Members

Inherited from CompileOut1ToNFn[T]

Inherited from CompileOutFn[T]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

CompileOutLayerStackFn