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 job

Definition Classes: driver

InCatalog

Job

JobVersions

OutCatalog

com.here.platform.data.processing.driver.job

Job

case class Job(inCatalogs: Map[Id, InCatalog], outCatalog: OutCatalog, appInfo: Option[AppInfo], commitToken: Option[String]) extends Product with Serializable

Actual configuration for a job. Contains catalog changeset information along with multipart commit token which should be used to commit data.

The com.here.platform.data.processing.driver.Driver requires a Job to run.

inCatalogs: the set of upstream catalogs to use for processing, each with its com.here.platform.data.processing.catalog.Catalog.Id, HRNs and processing types.
outCatalog: the references to the output catalog
appInfo: the app info to use when committing to the output catalog
commitToken: multipart commit token

Note: For unit test, synthesize a Job class directly with the parameters needed for the tests

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Job
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Job(inCatalogs: Map[Id, InCatalog], outCatalog: OutCatalog, appInfo: Option[AppInfo], commitToken: Option[String])
inCatalogs
the set of upstream catalogs to use for processing, each with its com.here.platform.data.processing.catalog.Catalog.Id, HRNs and processing types.
outCatalog
the references to the output catalog
appInfo
the app info to use when committing to the output catalog
commitToken
multipart commit token

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
val appInfo: Option[AppInfo]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
val commitToken: Option[String]
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()
val inCatalogs: Map[Id, InCatalog]
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 outCatalog: OutCatalog
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toJobVersions: JobVersions
Converts a complex Job description to the case class with just the versions being compiled.
Converts a complex Job description to the case class with just the versions being compiled.
returns
the JobVersions instance with just the version information extracted from Job
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

Job

case class Job(inCatalogs: Map[Id, InCatalog], outCatalog: OutCatalog, appInfo: Option[AppInfo], commitToken: Option[String]) 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

Job 

case class Job(inCatalogs: Map[Id, InCatalog], outCatalog: OutCatalog, appInfo: Option[AppInfo], commitToken: Option[String]) 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

Job