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

Fingerprints

Companion object Fingerprints

final class Fingerprints extends AnyRef

Fingerprints of compilation. They are constructed from both source code and configuration. The library uses the fingerprints, for example, to verify that the incremental compilation is done using the same setup as a previous full compilation, and to disable incremental compilation otherwise.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Fingerprints
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Fingerprints(frameworkVersion: String, compilerVersion: String, configurationHashCode: Int, scalaBinaryVersion: String, inputCatalogSubsetsFingerprints: Map[String, String] = Map.empty, customHashCodes: Map[String, Int] = Map.empty, customUnnamedHashCodes: List[Int] = Nil)
frameworkVersion
The version of the processing library creating the fingerprints.
compilerVersion
The version of the compiler creating the fingerprints.
configurationHashCode
The hash code of the compiler configuration.
scalaBinaryVersion
The Scala version substring describing binary compatibility this version of the processing library depends on.
inputCatalogSubsetsFingerprints
Subsets fingerprints of all access restricted input catalogs.
customHashCodes
Map of custom hash codes, indexed by unique IDs. These can be used to store in the fingerprints additional hashes of data that is used for compilation but it is not passed as inData to the executors. Storing this information is important as incremental compilation must be disabled if this data changes. For example, hash codes of the broadcast variables used by one or more driver task can be stored here.
customUnnamedHashCodes
Sequence of unnamed custom hash codes. Unlike the named hash codes, the order of insertion is significant in this case.

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 addCustomHash(hash: Int): Unit
Adds a custom hash code to fingerprints.
Adds a custom hash code to fingerprints.
You can use this function if you have custom data that may affect compilation, to disable incremental compilation in case it changes.
hash
The hash code to be added.
def addCustomHash(hash: Int, id: String): Unit
Adds a custom hash code to fingerprints.
Adds a custom hash code to fingerprints.
You can use this function if you have custom data that may affect compilation, to disable incremental compilation in case it changes.
hash
The hash code to be added.
id
The ID of the custom hash code. Hash codes with IDs can be provided in any order.
def aggregatedCustomHashCodes: Int
The custom named hash codes aggregated into a single one.
def aggregatedCustomUnnamedHashCodes: Int
The custom unnamed hash codes aggregated into a single one.
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()
val compilerVersion: String
val configurationHashCode: Int
def copy(frameworkVersion: String = frameworkVersion, compilerVersion: String = compilerVersion, configurationHashCode: Int = configurationHashCode, scalaBinaryVersion: String = scalaBinaryVersion, inputCatalogSubsetsFingerprints: Map[String, String] = inputCatalogSubsetsFingerprints, customHashCodes: Map[String, Int] = customHashCodes, customUnnamedHashCodes: List[Int] = customUnnamedHashCodes): Fingerprints
Creates a copy of the fingerprints, optionally overriding each component.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(that: Any): Boolean
equals method override.
equals method override.
Definition Classes
Fingerprints → AnyRef → Any
val frameworkVersion: String
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
hashCode method override.
hashCode method override.
Definition Classes
Fingerprints → 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()
val scalaBinaryVersion: String
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toJSON: JObject
Converts the fingerprints object to JSON.
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

Fingerprints

Companion object Fingerprints

final class Fingerprints extends AnyRef

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Fingerprints

Companion object Fingerprints

final class Fingerprints extends AnyRef

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Fingerprints