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
CatalogConfig
CatalogsConfig
CompileInConfig
CompileOutConfig
CompleteConfig
DriverConfig
ExecutorConfig
ExecutorDebugConfig
PartitionKeyFilterConfig
RefTreeExecutorConfig
SparkStorageLevelsConfig
StateConfig

com.here.platform.data.processing.driver.config

CompleteConfig

Companion object CompleteConfig

trait CompleteConfig extends AnyRef

Provides the complete configuration available to the processing library and compilers. This configuration combines all the information specified in the library's reference.conf, in the compilers' application.conf, and via the command line parameters.

Linear Supertypes

AnyRef, Any

Known Subclasses

CompleteConfigLoader

Ordering

Alphabetic
By Inheritance

Inherited

CompleteConfig
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def asTypesafeConfig: Config
The complete config object to retrieve any parameters by name.
The complete config object to retrieve any parameters by name.
The configuration is loaded and validated when the object is first referenced. The default configuration is loaded from the application.conf/json/properties in the classpath; you can override this with the system properties config.file/resource/url.
abstract def compilerConfig: Config
Compiler-specific parameters, obtained from the configuration section here.platform.data-processing.compiler.
Compiler-specific parameters, obtained from the configuration section here.platform.data-processing.compiler.
This config can be converted to a case class instance for convenient access using a wrapping library, for example Ficus:
```
import net.ceedubs.ficus.Ficus._
import net.ceedubs.ficus.readers.ArbitraryTypeReader._
val myCompilerConfig = completeConfig.compilerConfig.as[MyCompilerConfig]
```
abstract def driverConfig: DriverConfig
Library-specific parameters for the driver, obtained from the configuration section in here.platform.data-processing.driver.
Library-specific parameters for the driver, obtained from the configuration section in here.platform.data-processing.driver.
Note
This is an expensive operation; you should cache the results locally.
abstract def executorConfig(id: Id): ExecutorConfig
Library-specific parameters for the executors, obtained from the configuration section in here.platform.data-processing.executors or executor specific parameters under here.platform.data-processing.executors.byId, if available.
Library-specific parameters for the executors, obtained from the configuration section in here.platform.data-processing.executors or executor specific parameters under here.platform.data-processing.executors.byId, if available.
id
The identifier for the executor.
returns
the configuration for the executor specified by its ID.
Note
This is an expensive operation; you should cache the results locally.
abstract def compilerConfig[T <: AnyRef](implicit arg0: Manifest[T]): T
Compiler-specific parameters, obtained from the configuration section here.platform.data-processing.compiler.
Compiler-specific parameters, obtained from the configuration section here.platform.data-processing.compiler.
Annotations
@deprecated
Deprecated
(Since version batch-core-v2.4.12+) Use the non-generic version of compilerConfig that returns a Config instead.
Note
This is an expensive operation; you should cache the results locally.

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

CompleteConfig

Companion object CompleteConfig

trait CompleteConfig extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CompleteConfig

Companion object CompleteConfig

trait CompleteConfig extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

CompleteConfig