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 java

This package provides Java bindings for the Data Processing Library, to build distributed data processing applications in Java.

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.java.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 implement a com.here.platform.data.processing.java.compiler.Direct1ToNCompiler.

Other more complex compilation patterns are based on different types of dependency tracking between input partitions and output partitions.

The processing Library supports the following patterns:

- com.here.platform.data.processing.java.compiler.NonIncrementalCompiler: non-incremental compilation only - com.here.platform.data.processing.java.compiler.DepCompiler: non-incremental dependency calculation and incremental compilation - com.here.platform.data.processing.java.compiler.IncrementalDepCompiler: incremental dependency calculation and compilation - com.here.platform.data.processing.java.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.java.compiler.DirectMToNCompiler: incremental compilation where every output tile can depend on multiple input tiles, and this mapping is independent from tile content - com.here.platform.data.processing.java.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.java.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 extends a runner class (like PipelineRunner) to setup the Driver, and interfaces with the environment where the application runs. For more details, see the Main classes in the example compilers.

com.here.platform.data.processing.java.catalog, com.here.platform.data.processing.java.blobstore, and com.here.platform.data.processing.java.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: processing

package driver

Definition Classes: java

package config

Definition Classes: driver

package filter

Definition Classes: driver

package job

Definition Classes: driver

MultiCompilerTaskBuilder

TaskBuilder

TaskResult

com.here.platform.data.processing.java.driver

Default

object Default

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Default
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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 val FeedbackCatalogId: String
The identifier that refers to output catalog in the version produced by the previous compiler run, also referred to as the feedback catalog.
The identifier that refers to output catalog in the version produced by the previous compiler run, also referred to as the feedback catalog.
The feedback catalog can be used as further input for compilation. The feedback catalog identifier always refers to the base version of the output catalog.
Note
Use the OutCatalogId to generate output partitions, not the FeedbackCatalogId.
final def FixedVersionId(catalogId: String, fixedVersion: Version): String
Defines a catalog identifier to refer to a fixed version of the catalog.
Defines a catalog identifier to refer to a fixed version of the catalog. Given a catalog identifier and a version, the returned identifier refers the catalog in that version.
The fixed version is not provided by the pipeline job configuration but can, for example, be configured in the compiler configuration, read from an input catalog or be hardcoded in the source code of the compiler.
catalogId
A catalog identifier from the configuration of the pipeline.
fixedVersion
The version of the catalog to which should be referred.
returns
A catalog identifier that refers to the given catalog at a fixed version.
Note
If two subsequent runs of the same compiler access different fixed versions of a catalog, the second run will be non-incremental to avoid data inconsistencies. Example 1:
Default.FixedVersionId(Default.OutCatalogId, 2)
refers to the output catalog in version 2. Example 2:
Default.FixedVersionId("inputA", 5)
refers to the input catalog "inputA" in version 5.
final val OutCatalogId: String
The identifier that refers to the output catalog in the driver.
The identifier that refers to the output catalog in the driver. Compilers should generate output partition keys using this output catalog ID.
final def PreviousRunId(catalogId: String, previousRun: Long): String
Defines a catalog identifier to refer to a specific version of the catalog.
Defines a catalog identifier to refer to a specific version of the catalog. Given an input catalog identifier, the augmented identifier refers the catalog version used by the given previous compilation; given the output catalog identifier, the augmented identifier refers to the catalog version produced by the given previous compilation.
Example 1:
```
Default.PreviousRunId("inputA", 2)
```
refers to the input catalog "inputA" in the version used in the second most recent compilation.
Example 2:
```
Default.PreviousRunId(Default.OutCatalogId, 1)
```
refers to the output catalog produced by the previous compilation, that is, the feedback catalog.
catalogId
A catalog identifier from the configuration of the pipeline.
previousRun
The number of compilations to go back in time. For example, 1 refers to the previous version of the output catalog; 2 refers to the version before that. Must be greater than 0.
returns
A catalog identifier that refers to the given catalog at a previous run.
final def PreviousRunId(catalogId: String): String
Defines a catalog identifier to refer to a specific version of the catalog.
Defines a catalog identifier to refer to a specific version of the catalog. Given an input catalog identifier, the augmented identifier refers the catalog version used by the previous compilation; given the output catalog identifier, the augmented identifier refers to the catalog version produced by the previous compilation.
Example 1:
```
Default.PreviousRunId("inputA")
```
refers to the input catalog "inputA" in the version used in the previous compilation.
Example 2:
```
Default.PreviousRunId(Default.OutCatalogId)
```
refers to the output catalog produced by the previous compilation, that is, the feedback catalog.
catalogId
A catalog identifier from the configuration of the pipeline.
returns
A catalog identifier that refers to the given catalog at the previous run.
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
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @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
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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

Default

object Default

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Default

object Default

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Default