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 catalog

Contains an abstract Scala interface for accessing catalogs from Spark.

Use the com.here.platform.data.processing.catalog.Catalog factory methods to obtain instances.

Definition Classes: processing

object Partition

Groups common types to represent partitions, both generic and tiles, as well as various types of metadata that are used in the various stages of processing.

Groups common types to represent partitions, both generic and tiles, as well as various types of metadata that are used in the various stages of processing. The information includes metadata returned by querying the catalog for a particular version, metadata returned by querying the differences between two versions, and metadata provided when committing a new version of a catalog.

Definition Classes: catalog

Change

ChangeWrapper

Checksum

Commit

CommitWrapper

Delete

Deleted

Generic

HereTile

Key

KeyOrName

Name

Companion object Name

sealed trait Name extends Serializable with KeyOrName

Name of the partition unique inside a layer.

Partition names may form a hierarchy. A name may have a parent name, that may also recursively have a parent name, until a name with no parent is reached.

Linear Supertypes

KeyOrName, Serializable, Serializable, AnyRef, Any

Known Subclasses

Generic, HereTile

Ordering

Alphabetic
By Inheritance

Inherited

Name
KeyOrName
Serializable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

abstract type ParentType <: Name
The type of the parent partition name

Abstract Value Members

abstract def ancestors: Seq[ParentType]
The names of the ancestors, that are the direct parent and its ancestors, in this order
abstract def level: Int
The level of the name in the hierarchy, that is the number of ancestors the name has
abstract def parent: Option[ParentType]
The name of the parent, when defined

Concrete 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 def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@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
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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

Name

Companion object Name

sealed trait Name extends Serializable with KeyOrName

Type Members

Abstract Value Members

Concrete Value Members

Inherited from KeyOrName

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Name 

Companion object Name

sealed trait Name extends Serializable with KeyOrName

Type Members

Abstract Value Members

Concrete Value Members

Inherited from KeyOrName

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Name