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 compiler

Definition Classes: processing

package reftree

Definition Classes: compiler

CompileInFn

CompileInFnWithRefs

CompileInFnWithRefsReturnsReferences

Ref

com.here.platform.data.processing.compiler.reftree

Ref

case class Ref(refName: RefName, layer: (Id, Id), refs: Ref*) extends RefBase with Product with Serializable

Reference from layer A to layer B means that a partition on layer A may potentially require one or more partitions on layer B for compilation.

Describes a reference that goes from some unknown in this context source layer to the layer defined by the field layer. It also defines child references that go from the layer to other layers.

refName: a name of the reference to this layer from. The name must be unique in scope of the whole tree
layer: the source layer from which the reference refer other layers
refs: the child references

Linear Supertypes

Serializable, Product, Equals, RefBase, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Ref
Serializable
Product
Equals
RefBase
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Ref(refName: RefName, layer: (Id, Id), refs: Ref*)
refName
a name of the reference to this layer from. The name must be unique in scope of the whole tree
layer
the source layer from which the reference refer other layers
refs
the child references

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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
val layer: (Id, Id)
Layer in a catalog.
Layer in a catalog. Either subject of referenced layer in the reference tree model.
Definition Classes
Ref → RefBase
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
def productElementNames: Iterator[String]
Definition Classes
Product
val refName: RefName
val refs: Ref*
References to other layers.
References to other layers.
Definition Classes
Ref → RefBase
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Packages

Ref

case class Ref(refName: RefName, layer: (Id, Id), refs: Ref*) extends RefBase with Product with Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RefBase

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Ref

case class Ref(refName: RefName, layer: (Id, Id), refs: Ref*) extends RefBase with Product with Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RefBase

Inherited from AnyRef

Inherited from Any

Ungrouped

Ref