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

package deltasets

Definition Classes: driver

package filter

Definition Classes: driver

package impl

Definition Classes: driver

package job

Definition Classes: driver

InCatalog

Job

JobVersions

OutCatalog

package modes

Definition Classes: driver

package runner

Definition Classes: driver

com.here.platform.data.processing.driver

job

package job

Type Members

case class InCatalog(hrn: HRN, processingType: ProcessingType) extends Product with Serializable
What is needed to process data from an input catalog
What is needed to process data from an input catalog
hrn
HRN of the catalog that should be processed
processingType
Which version(s) of this catalog should be processed
case class Job(inCatalogs: Map[Id, InCatalog], outCatalog: OutCatalog, appInfo: Option[AppInfo], commitToken: Option[String]) extends Product with Serializable
Actual configuration for a job.
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
case class JobVersions(inCatalogs: Map[Id, ProcessingType], outCatalog: BaseVersion) extends Product with Serializable
A reduced version of Job, that contains just the versions being processed.
A reduced version of Job, that contains just the versions being processed.
inCatalogs
the set of upstream catalogs to use for processing, each with its com.here.platform.data.processing.catalog.Catalog.Id and which versions to process
outCatalog
the com.here.platform.data.processing.catalog.utils.BaseVersion of the output catalog on top of which it is being committed

Note
For unit test, synthesize a JobVersions class directly with the parameters needed for the tests
case class OutCatalog(hrn: HRN, baseVersion: BaseVersion) extends Product with Serializable
Contains what is needed to publish to the output catalog.
Contains what is needed to publish to the output catalog.
hrn
HRN of the output catalog
baseVersion
the base version of the catalog on top of which to commit

Packages

job 

package job

Type Members

Ungrouped

job