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 blobstore

Java bindings for the blobstore package.

Definition Classes: java

package broadcast

Provides the basic functionality to perform org.apache.spark.broadcast.Broadcast creation.

To use a broadcast variable in the processing library, developers are required to add the variable's hash to the fingerprints. This ensures that incremental compilations are not compromised. This package object provides the method toBroadcast() to use for that purpose. The package also offers a functionality to query catalogs by properly managing versions. The functionality is based on the org.apache.spark.broadcast.Broadcast which offers a self-contained mechanism to create a single broadcast variable of a generic type.

This compiler class is the preferred way of working with broadcast variables in the Data Processing Library.

Definition Classes: java

package catalog

Java bindings for the catalog package.

Definition Classes: java

package compiler

Definition Classes: java

package driver

Definition Classes: java

package impl

Definition Classes: java

package leveling

Definition Classes: java

package publisher

Definition Classes: java

package spark

Definition Classes: java

package utils

Definition Classes: java

Java

Pair

com.here.platform.data.processing.java

Pair

final class Pair[K, V] extends org.apache.commons.lang3.tuple.Pair[K, V]

Immutable implementation of org.apache.commons.lang3.tuple.Pair.

K: type of the left member of the pair
V: type of the right member of the pair

Linear Supertypes

org.apache.commons.lang3.tuple.Pair[K, V], Serializable, Comparable[org.apache.commons.lang3.tuple.Pair[K, V]], Entry[K, V], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Pair
Pair
Serializable
Comparable
Entry
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Pair(left: K, right: V)
left
left member of the pair
right
right member of the pair

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
def accept[E <: Throwable](arg0: FailableBiConsumer[K, V, E]): Unit
Definition Classes
Pair
Annotations
@throws(classOf[java.lang.Throwable])
def apply[V <: AnyRef, E <: Throwable](arg0: FailableBiFunction[K, V, V, E]): V
Definition Classes
Pair
Annotations
@throws(classOf[java.lang.Throwable])
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()
def compareTo(arg0: org.apache.commons.lang3.tuple.Pair[K, V]): Int
Definition Classes
Pair → Comparable
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
Pair → Entry → AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
final def getKey(): K
Definition Classes
Pair → Entry
def getLeft(): K
Definition Classes
Pair → Pair
def getRight(): V
Definition Classes
Pair → Pair
def getValue(): V
Definition Classes
Pair → Entry
def hashCode(): Int
Definition Classes
Pair → Entry → AnyRef → Any
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(arg0: String): String
Definition Classes
Pair
def toString(): String
Definition Classes
Pair → AnyRef → Any
def toTuple: (K, V)
Converts this pair to a scala scala.Tuple2.
Converts this pair to a scala scala.Tuple2.
returns
this as a scala scala.Tuple2
Note
This is a convenient method to ease interoperability with Spark pairs.
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)
def setValue(value: V): V
Definition Classes
Pair → Entry
Annotations
@Deprecated
Deprecated

Packages

Pair

final class Pair[K, V] extends org.apache.commons.lang3.tuple.Pair[K, V]

Instance Constructors

Value Members

Deprecated Value Members

Inherited from org.apache.commons.lang3.tuple.Pair[K, V]

Inherited from Serializable

Inherited from Comparable[org.apache.commons.lang3.tuple.Pair[K, V]]

Inherited from Entry[K, V]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Pair

final class Pair[K, V] extends org.apache.commons.lang3.tuple.Pair[K, V]

Instance Constructors

Value Members

Deprecated Value Members

Inherited from org.apache.commons.lang3.tuple.Pair[K, V]

Inherited from Serializable

Inherited from Comparable[org.apache.commons.lang3.tuple.Pair[K, V]]

Inherited from Entry[K, V]

Inherited from AnyRef

Inherited from Any

Ungrouped

Pair