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 java
This package provides Java bindings for the Data Processing Library, to build distributed data processing applications in Java.
This package provides Java bindings for the Data Processing Library, to build distributed data processing applications in Java.
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.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 impl

Definition Classes
java
package compiler

Definition Classes
impl
package direct

Definition Classes
compiler
package mapgroup

Definition Classes
compiler
package reftree

Definition Classes
compiler
ConcreteDepCompiler
ConcreteDirect1ToNCompiler
ConcreteDirectMToNCompiler
ConcreteDirectMapGroupCompiler
ConcreteIncrementalDepCompiler
ConcreteNonIncrementalCompiler
ConcreteRefTreeCompiler
Converters
DepCompilerWrapper
IncrementalDepCompilerWrapper
InputPartitionerWrapper
NonIncrementalCompilerWrapper
OutputPartitionerWrapper
WrapperCompileOut1To1Fn
WrapperCompileOut1ToNFn
WrapperCompileOutFn
WrapperDirect1ToNCompiler
WrapperDirectMToNCompiler
WrapperInputLayers
WrapperInputOptPartitioner
WrapperMapGroupCompiler
WrapperOutputLayers
WrapperOutputOptPartitioner
WrapperRefTreeCompiler

com.here.platform.data.processing.java.impl.compiler

WrapperDirect1ToNCompiler

Companion object WrapperDirect1ToNCompiler

trait WrapperDirect1ToNCompiler[T, W <: Direct1ToNCompiler[T]] extends Direct1ToNCompiler[T] with WrapperInputLayers[W] with WrapperInputOptPartitioner[W] with WrapperCompileInFn[T, W] with WrapperOutputLayers[W] with WrapperOutputOptPartitioner[W] with compiler.direct.WrapperCompileOutFn[T, W]

Linear Supertypes

direct.WrapperCompileOutFn[T, W], WrapperOutputOptPartitioner[W], WrapperOutputLayers[W], WrapperCompileInFn[T, W], WrapperInputOptPartitioner[W], WrapperInputLayers[W], Wrapper[W], Direct1ToNCompiler[T], CompileOutFn[T], OutputOptPartitioner, OutputLayers, CompileInFn[T], Serializable, Serializable, InputOptPartitioner, InputLayers, AnyRef, Any

Known Subclasses

ConcreteDirect1ToNCompiler

Ordering

Alphabetic
By Inheritance

Inherited

WrapperDirect1ToNCompiler
WrapperCompileOutFn
WrapperOutputOptPartitioner
WrapperOutputLayers
WrapperCompileInFn
WrapperInputOptPartitioner
WrapperInputLayers
Wrapper
Direct1ToNCompiler
CompileOutFn
OutputOptPartitioner
OutputLayers
CompileInFn
Serializable
Serializable
InputOptPartitioner
InputLayers
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def impl: W

Definition Classes
Wrapper

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()
def compileInFn(in: (InKey, InMeta)): T
Calculates the intermediate result from a single input partition.
Calculates the intermediate result from a single input partition. The result will be provided together with the input key in the com.here.platform.data.processing.compiler.direct.CompileOutFn.
in
the input partition to process
returns
the value of intermediate data of type T for this partition. This value will be passed in com.here.platform.data.processing.compiler.direct.CompileOutFn to all output keys impacted by the in partition.

Definition Classes
WrapperCompileInFn → CompileInFn
def compileOutFn(outKey: OutKey, intermediate: T): Option[Payload]
Compiles a single output partition from intermediate data of a single input partition.
Compiles a single output partition from intermediate data of a single input partition. This function will only be called for output keys that were returned in com.here.platform.data.processing.compiler.direct.CompileInFn.
Output keys which are no longer mapped to the mapping function calls, for example due to deleted input partitions in incremental processing, get deleted automatically.
outKey
Key of the output partition to generate
intermediate
Intermediate value calculated by com.here.platform.data.processing.compiler.direct.CompileInFn.compileInFn for the input partition that was mapped to this output key
returns
scala.Options of com.here.platform.data.processing.blobstore.Payload, with either the partition content, or None if there is no data to be published.

Definition Classes
WrapperCompileOutFn → CompileOutFn
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
Wrapper → 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
Wrapper → AnyRef → Any
def inLayers: Map[Id, Set[Id]]
Represents layers of the input catalogs that you should query and provide to the compiler.
Represents layers of the input catalogs that you should query and provide to the compiler. These layers are grouped by input catalog and identified by catalog ID and layer ID.

Definition Classes
WrapperInputLayers → InputLayers
def inPartitioner(parallelism: Int): Option[Partitioner[InKey]]
Specifies the partitioner to use when querying the input catalogs.
Specifies the partitioner to use when querying the input catalogs. If no partitioner is provided, by returning None from this function, then the Executor uses the default partitioner.
parallelism
The number of partitions the partitioner should partition the catalog into, this should match the parallelism of the Spark RDD containing the input partitions.
returns
The optional input partitioner with the parallelism specified.

Definition Classes
WrapperInputOptPartitioner → InputOptPartitioner
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mappingFn(inKey: InKey): Iterable[OutKey]
Calculates which output partitions, if any, are affected by the given single input partition.
Calculates which output partitions, if any, are affected by the given single input partition. The mapping must be function of only the input com.here.platform.data.processing.compiler.InKey.
The metadata is intentionally not provided, because the result of this call cannot be function of the metadata and therefore the data. This is because the direct.CompileInFn implementation does not perform a stateful dependency-tracking for incremental compilation. If the function would use additional information from the tile content, it would break incremental compilation use case.
inKey
the input partition being mapped
returns
the output partitions that the given input partition maps to

Definition Classes
WrapperCompileInFn → CompileInFn
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 val outCatalogId: Id
Identifier for the output catalog.
Identifier for the output catalog.

Definition Classes
OutputLayers
def outLayers: Set[Id]
Layers to be produced by the compiler.
Layers to be produced by the compiler.

Definition Classes
WrapperOutputLayers → OutputLayers
def outPartitioner(parallelism: Int): Option[Partitioner[OutKey]]
Specifies the partitioner to use when querying the output catalog and producing output data.
Specifies the partitioner to use when querying the output catalog and producing output data. If no partitioner is provided, by returning None from this function, then the Executor uses the default partitioner.
parallelism
The number of partitions the partitioner should partition the catalog into, this should match the parallelism of the Spark RDD containing the output partitions.
returns
The optional output partitioner with the parallelism specified.

Definition Classes
WrapperOutputOptPartitioner → OutputOptPartitioner
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Wrapper → 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

WrapperDirect1ToNCompiler

Companion object WrapperDirect1ToNCompiler

trait WrapperDirect1ToNCompiler[T, W <: Direct1ToNCompiler[T]] extends Direct1ToNCompiler[T] with WrapperInputLayers[W] with WrapperInputOptPartitioner[W] with WrapperCompileInFn[T, W] with WrapperOutputLayers[W] with WrapperOutputOptPartitioner[W] with compiler.direct.WrapperCompileOutFn[T, W]

Abstract Value Members

Concrete Value Members

Inherited from direct.WrapperCompileOutFn[T, W]

Inherited from WrapperOutputOptPartitioner[W]

Inherited from WrapperOutputLayers[W]

Inherited from WrapperCompileInFn[T, W]

Inherited from WrapperInputOptPartitioner[W]

Inherited from WrapperInputLayers[W]

Inherited from Wrapper[W]

Inherited from Direct1ToNCompiler[T]

Inherited from CompileOutFn[T]

Inherited from OutputOptPartitioner

Inherited from OutputLayers

Inherited from CompileInFn[T]

Inherited from Serializable

Inherited from Serializable

Inherited from InputOptPartitioner

Inherited from InputLayers

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

WrapperDirect1ToNCompiler 

Companion object WrapperDirect1ToNCompiler

trait WrapperDirect1ToNCompiler[T, W <: Direct1ToNCompiler[T]] extends Direct1ToNCompiler[T] with WrapperInputLayers[W] with WrapperInputOptPartitioner[W] with WrapperCompileInFn[T, W] with WrapperOutputLayers[W] with WrapperOutputOptPartitioner[W] with compiler.direct.WrapperCompileOutFn[T, W]

Abstract Value Members

Concrete Value Members

Inherited from direct.WrapperCompileOutFn[T, W]

Inherited from WrapperOutputOptPartitioner[W]

Inherited from WrapperOutputLayers[W]

Inherited from WrapperCompileInFn[T, W]

Inherited from WrapperInputOptPartitioner[W]

Inherited from WrapperInputLayers[W]

Inherited from Wrapper[W]

Inherited from Direct1ToNCompiler[T]

Inherited from CompileOutFn[T]

Inherited from OutputOptPartitioner

Inherited from OutputLayers

Inherited from CompileInFn[T]

Inherited from Serializable

Inherited from Serializable

Inherited from InputOptPartitioner

Inherited from InputLayers

Inherited from AnyRef

Inherited from Any

Ungrouped

WrapperDirect1ToNCompiler