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 catalog

Java bindings for the catalog package.

Definition Classes: java

package partition

Definition Classes: catalog

package partitioning

Definition Classes: catalog

package utils

Definition Classes: catalog

Catalog

CatalogFactory

CatalogLight

CatalogLightFactory

CatalogView

CatalogViewAtVersion

CatalogViewSinceVersion

CommitPart

CommitToken

Configuration

EmptyCatalogView

LayerConfiguration

NonEmptyCatalogView

WrappedAbstractType

com.here.platform.data.processing.java.catalog

CatalogViewAtVersion

final class CatalogViewAtVersion extends CatalogView with NonEmptyCatalogView

Provides a view on a specific version of a catalog, without a reference to a previous version of the catalog.

Linear Supertypes

NonEmptyCatalogView, CatalogView, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

CatalogViewAtVersion
NonEmptyCatalogView
CatalogView
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new CatalogViewAtVersion(catalog: Catalog, version: Version)
catalog
The catalog which is encapsulated by this view.
version
The version of the catalog. Must be non-negative.

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
val catalog: Catalog
The catalog which is encapsulated by this view.
The catalog which is encapsulated by this view.

Definition Classes
CatalogViewAtVersion → CatalogView
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def empty(partitioner: PartitionerOfKey): JavaPairRDD[Key, Meta]
Creates a partitioned empty RDD of (Key, Meta) in compliance with other methods of this component.
Creates a partitioned empty RDD of (Key, Meta) in compliance with other methods of this component.
partitioner
The com.here.platform.data.processing.java.spark.partitioner.PartitionerOfKey applied when constructing the RDD returned.
returns
An empty RDD of (com.here.platform.data.processing.java.catalog.partition.Key, com.here.platform.data.processing.java.catalog.partition.Meta), which is partitioned according to the partitioner parameter.

Definition Classes
CatalogView
def empty(): JavaPairRDD[Key, Meta]
Creates a partitioned empty RDD of (Key, Meta) in compliance with other methods of this component.
Creates a partitioned empty RDD of (Key, Meta) in compliance with other methods of this component. This version uses the root log context.
returns
An empty RDD of (com.here.platform.data.processing.java.catalog.partition.Key, com.here.platform.data.processing.java.catalog.partition.Meta), which is partitioned according to the default partitioner of the catalog.

Definition Classes
CatalogView
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()
def hrn: HRN
The HRN (HERE Resource Name) of the catalog.
The HRN (HERE Resource Name) of the catalog. It is a resource descriptor that provides a globally unique handle for a catalog in the sense of an instance.

Definition Classes
CatalogView
def id: String
The unique identifier for the catalog, that is added to every com.here.platform.data.processing.java.catalog.partition.Key returned by the query APIs and is used by the commit API for logging and statistics generation.
The unique identifier for the catalog, that is added to every com.here.platform.data.processing.java.catalog.partition.Key returned by the query APIs and is used by the commit API for logging and statistics generation.

Definition Classes
CatalogView
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()
def queryAll(layers: Set[String], partitioner: PartitionerOfKey): JavaPairRDD[Key, Meta]
Queries metadata of all the partitions in a given set of layers.
Queries metadata of all the partitions in a given set of layers.
Creates an RDD containing the queried metadata.
layers
The set of layers for which the partitions should be queried.
partitioner
The com.here.platform.data.processing.spark.partitioner.Partitioner applied when constructing the RDD returned.
returns
The queried metadata in an RDD object partitioned according to the partitioner parameter.

Definition Classes
NonEmptyCatalogView
def queryAll(layers: Set[String]): JavaPairRDD[Key, Meta]
Queries metadata of all the partitions in a given set of layers.
Queries metadata of all the partitions in a given set of layers.
Creates an RDD containing the queried metadata.
layers
The set of layers for which the partitions should be queried.
returns
The queried metadata in an RDD object partitioned according to the default partitioner of the catalog.

Definition Classes
NonEmptyCatalogView
def queryDependencies(): List[Dependency]
Queries the dependencies of the catalog at the version of the view.
Queries the dependencies of the catalog at the version of the view.
returns
The dependencies of the catalog version.

Definition Classes
NonEmptyCatalogView
def retriever: Retriever
Exposes the Retriever for this catalog.
Exposes the Retriever for this catalog. The returned object can be captured in Spark functions and transmitted to worker nodes.

Definition Classes
CatalogView
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
val version: Version
The catalog version which is encapsulated by this view.
The catalog version which is encapsulated by this view. Must be non-negative.

Definition Classes
CatalogViewAtVersion → NonEmptyCatalogView
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

CatalogViewAtVersion

final class CatalogViewAtVersion extends CatalogView with NonEmptyCatalogView

Instance Constructors

Value Members

Inherited from NonEmptyCatalogView

Inherited from CatalogView

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CatalogViewAtVersion 

final class CatalogViewAtVersion extends CatalogView with NonEmptyCatalogView

Instance Constructors

Value Members

Inherited from NonEmptyCatalogView

Inherited from CatalogView

Inherited from AnyRef

Inherited from Any

Ungrouped

CatalogViewAtVersion