HERE Data SDK - Scala API references < Back

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.
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 driver
Definition Classes
processing
package config
This package contains the configuration classes for all components of a Driver.
This package contains the configuration classes for all components of a Driver. Configuration is read from application.conf and provided to the developer as a com.here.platform.data.processing.driver.config.CompleteConfig instance, when the driver is setup.
Definition Classes
driver
package deltasets
Definition Classes
driver
package filter
Definition Classes
driver
package impl
Definition Classes
driver
package job
Definition Classes
driver
package modes
Definition Classes
driver
package runner
Definition Classes
driver
Default
DeltaDriverTask
DeltaDriverTaskBuilder
DeltaSetup
DeltaSimpleSetup
Driver
DriverBuilder
DriverContext
DriverSetup
DriverSetupManual
DriverSetupWithBuilder
DriverTask
Executor
Fingerprints
IncrementalCompilerExecutor
MultiCompilerTaskBuilder
MultiModeDriverTask
NonIncrementalCompilerExecutor
PartitionKeyFiltering
StatefulCompilerExecutor
TaskBuilder
TaskResult

com.here.platform.data.processing.driver

DriverContext

Companion object DriverContext

trait DriverContext extends AnyRef

Provides access to a set of common resources which a Driver has, that can be used by DriverTasks and Compilers.

Linear Supertypes

AnyRef, Any

Known Subclasses

DriverContextImpl

Ordering

Alphabetic
By Inheritance

Inherited

DriverContext
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def commitToken: Option[String]
The commit token to use when performing the final commit, if available.
abstract def completeConfig: CompleteConfig
The original complete configuration used to create this context.
abstract def config: DriverConfig
The original driver configuration used to create this context.
abstract def feedbackCatalog: Catalog with QueryReuse
The feedback catalog.
abstract def feedbackCatalogConfiguration: Configuration
Configuration of the feedback catalog.
abstract def feedbackCatalogId: Id
Identifier of the feedback catalog.
abstract def feedbackRetriever: Retriever
To retrieve payloads of partitions of the feedback catalog.
abstract def fingerprints: Fingerprints
The fingerprints of the current environment.
abstract def inCatalogConfigurations: Map[Id, Configuration]
Configurations of each input catalog.
abstract def inCatalogView(id: Id): CatalogView
Can be used to a construct a view on the latest version of an input catalog.
Can be used to a construct a view on the latest version of an input catalog.
id
The catalog identifier of an input catalog or the feedback catalog.
returns
A view on the latest version of the input catalog, or a view on the feedback version of the output catalog.
abstract def inCatalogs: Map[Id, Catalog with QueryReuse]
The input catalogs.
abstract def inRetriever(id: Id): Retriever
To retrieve payloads of partitions of the input catalog.
abstract def job: Job
The full description of the current job.
abstract def jobVersions: JobVersions
The description of the current job, with details about versions and changes in catalogs.
abstract def outCatalog: Catalog with QueryPersistence
The output catalog.
abstract def outCatalogConfiguration: Configuration
Configuration of the output catalog.
abstract def outCatalogId: Id
Identifier of the output catalog provided in the com.here.platform.data.processing.driver.job.Job.
abstract def outRetriever: Retriever
To retrieve payloads of partitions of the output catalog.
abstract def publisher: Publisher
To prepare a commit by uploading only the changed payloads and calculating the metadata for the commit.
abstract def rebaseContext: RebaseContext
Current rebase context, applicable if the output catalog has composite layers.
Current rebase context, applicable if the output catalog has composite layers. Indicates whether a rebase is happening (update of the base output catalog), which in most cases requires a special handling.
See also
com.here.platform.data.processing.publisher.Publisher
abstract def spark: SparkContext
The Spark context as part of which the Driver is running.
abstract def statistics: Statistics
The statistics.
abstract def uploader: Uploader
To upload new payloads for partitions of the output catalog.
abstract def inRetrievers: Map[Id, Retriever]
To retrieve payloads of partitions of the input catalog.
To retrieve payloads of partitions of the input catalog.
Annotations
@deprecated
Deprecated
(Since version 2.8.31) Use the inRetriever method of DriverContext instead

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(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

DriverContext

Companion object DriverContext

trait DriverContext extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

DriverContext

Companion object DriverContext

trait DriverContext extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

DriverContext