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

BroadcastCompiler

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

com.here.platform.data.processing.java

broadcast

package broadcast

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

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

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

broadcast
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

abstract class BroadcastCompiler[T] extends InputLayers with InputOptPartitioner
Offers the interface for the data compilation supposed to be stored on a Spark org.apache.spark.broadcast.Broadcast variable.
Offers the interface for the data compilation supposed to be stored on a Spark org.apache.spark.broadcast.Broadcast variable.
Compiled data is an object instance of type T. The suggested use of this functionality is to: - perform the broadcast creations during the driver setting up. - send the broadcast variables to the compiler which is under creation as a parameter.
T
the type of the object to be stored in the broadcast variable

Value Members

def queryInputMeta(context: DriverContext, inLayers: Map[String, Set[String]], inPartitioner: InputOptPartitioner, parallelism: Int): JavaPairRDD[InKey, InMeta]
Gets the input metadata from the input catalogs at the version that needs to be compiled.
Gets the input metadata from the input catalogs at the version that needs to be compiled.
context
the com.here.platform.data.processing.java.driver.DriverContext object
inLayers
the input layers
inPartitioner
the input partition option, if empty a default hash based partitioner on the default parallelism will be used
parallelism
the parallelism of both the output RDD
returns
the input metadata RDD
def toBroadcast[T](context: DriverContext, t: T, fingerprint: Int, fingerprintId: String, clazz: Class[T]): Broadcast[T]
Creates a broadcast variable out of an object instance of type T.
Creates a broadcast variable out of an object instance of type T.
Please note that this method updates a mutable content in the com.here.platform.data.processing.java.driver.DriverContext object: it changes a shared status. Multiple calls to this functionality should then happen in a deterministic order.
The normal use of this functionality is to: - perform the broadcast creations during the driver setting up. - send the broadcast variables to the compiler which is under creation as a parameter.
T
the type of the broadcast variable under creation
context
the com.here.platform.data.processing.java.driver.DriverContext object
t
the object to create a broadcast variable out ot it
fingerprint
the fingerprint of the parameter t that will be stored in the com.here.platform.data.processing.driver.Fingerprints
fingerprintId
The ID used to store the fingerprint.
clazz
the Class of type T
returns
the broadcast variable

Note
the stability of the provided fingerprint calculation is crucial to not compromise subsequent incremental compilations
def toBroadcast[T](context: DriverContext, t: T, fingerprint: Int, clazz: Class[T]): Broadcast[T]
Creates a broadcast variable out of an object instance of type T.
Creates a broadcast variable out of an object instance of type T.
Please note that this method updates a mutable content in the com.here.platform.data.processing.java.driver.DriverContext object: it changes a shared status. Multiple calls to this functionality should then happen in a deterministic order.
The normal use of this functionality is to: - perform the broadcast creations during the driver setting up. - send the broadcast variables to the compiler which is under creation as a parameter.
T
the type of the broadcast variable under creation
context
the com.here.platform.data.processing.java.driver.DriverContext object
t
the object to create a broadcast variable out ot it
fingerprint
the fingerprint of the parameter t that will be stored in the com.here.platform.data.processing.driver.Fingerprints
clazz
the Class of type T
returns
the broadcast variable

Note
the stability of the provided fingerprint calculation is crucial to not compromise subsequent incremental compilations
def toBroadcast[T](context: DriverContext, t: T, fingerprintId: String, clazz: Class[T]): Broadcast[T]
Creates a broadcast variable out of an object instance of type T.
Creates a broadcast variable out of an object instance of type T.
Please note that this method updates a mutable content in the com.here.platform.data.processing.java.driver.DriverContext object: it changes a shared status. Multiple calls to this functionality should then happen in a deterministic order.
The normal use of this functionality is to: - perform the broadcast creations during the driver setting up. - send the broadcast variables to the compiler which is under creation as a parameter.
T
the type of the broadcast variable under creation
context
the com.here.platform.data.processing.java.driver.DriverContext object
t
the object to create a broadcast variable out ot it
fingerprintId
The ID used to store the fingerprint.
clazz
the Class of type T
returns
the broadcast variable

Note
as object hashes are added to fingerprints, objects of type T are supposed to have stable hashCode() methods, implemented based of the actual object content
def toBroadcast[T](context: DriverContext, t: T, clazz: Class[T]): Broadcast[T]
Creates a broadcast variable out of an object instance of type T.
Creates a broadcast variable out of an object instance of type T.
Please note that this method updates a mutable content in the com.here.platform.data.processing.java.driver.DriverContext object: it changes a shared status. Multiple calls to this functionality should then happen in a deterministic order.
The normal use of this functionality is to: - perform the broadcast creations during the driver setting up. - send the broadcast variables to the compiler which is under creation as a parameter.
T
the type of the broadcast variable under creation
context
the com.here.platform.data.processing.java.driver.DriverContext object
t
the object to create a broadcast variable out ot it
clazz
the Class of type T
returns
the broadcast variable

Note
as object hashes are added to fingerprints, objects of type T are supposed to have stable hashCode() methods, implemented based of the actual object content
def toBroadcastNoUpdateFingerprints[T](context: DriverContext, t: T, clazz: Class[T]): Broadcast[T]
Creates a broadcast variable out of an object instance of type T.
Creates a broadcast variable out of an object instance of type T. WARNING: the recompilation won't be triggered if a change of the broadcast object is detected.
The normal use of this functionality is to: - perform the broadcast creations during the driver setting up. - send the broadcast variables to the compiler which is under creation as a parameter.
T
the type of the broadcast variable under creation
context
the com.here.platform.data.processing.java.driver.DriverContext object
t
the object to create a broadcast variable out ot it
clazz
the Class of type T
returns
the broadcast variable

Note
As object hashes AREN'T added to the context fingerprints, so the recompilation won't be triggered if a change of the object is detected.

Packages

broadcast

package broadcast

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

broadcast 

package broadcast

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

broadcast