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 blobstore
Contains an abstract interface used to access BlobStore.
Contains an abstract interface used to access BlobStore.
Obtain the retriever and uploader for a catalog directly from the com.here.platform.data.processing.catalog.Catalog instance.
Definition Classes
processing
package engine
Definition Classes
blobstore
package v2
Contains an implementation used to access BlobStore using DataStore client.
Contains an implementation used to access BlobStore using DataStore client.
The retriever using the DataStore client library is Retriever. The uploader using the DataStore client library is Uploader.
Definition Classes
engine
ChecksumVersionIdGenerator
Digest
Retriever
Uploader

com.here.platform.data.processing.blobstore.engine.v2

Retriever

class Retriever extends blobstore.Retriever

Implements the Retriever abstraction using the DataStore client.

Linear Supertypes

blobstore.Retriever, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Retriever
Retriever
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Retriever(catalogId: Id, catalogHrn: HRN, appInfo: Option[AppInfo] = None, endpointLocatorSettings: Option[EndpointLocatorSettings] = None)
catalogId
the unique identifier for the catalog, for which this Retriever is being created
catalogHrn
the HRN of the catalog for which this Retriever is being created
appInfo
the optional app info used to work with DataStore. If undefined, the default DataStore client credentials are used.
endpointLocatorSettings
the endpoint locator settings used to work with DataStore

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 getPayload(key: Key, meta: Meta, file: File): Payload
Gets the Payload of a Partition by its key.
Gets the Payload of a Partition by its key. This method always returns a com.here.platform.data.processing.blobstore.FilePayload. Implementations of this method may be optimized so that the content in the retrieved partition is not fully loaded in memory.
key
The key identifying a partition.
meta
The metadata containing more details about the payload to be retrieved.
file
The file where the partition data must be copied into.
returns
the retrieved Payload.
Definition Classes
Retriever → Retriever
Note
It's the caller's responsibility to delete the file when it's no longer needed.
def getPayload(key: Key, meta: Meta): Payload
Gets the Payload of a Partition by its key.
Gets the Payload of a Partition by its key.
key
The key identifying a partition.
meta
The metadata containing more details about the payload to be retrieved.
returns
the retrieved Payload.
Definition Classes
Retriever → Retriever
def getPayloadAsInputStream(key: Key, meta: Meta): InputStream
Gets the Payload of a Partition by its key.
Gets the Payload of a Partition by its key. This method always returns an InputStream.
Please note that this method will not allow to cache the retrieved content.
key
The key identifying a partition.
meta
The metadata containing more details about the payload to be retrieved.
returns
the retrieving InputStream.
Definition Classes
Retriever → Retriever
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

Retriever

class Retriever extends blobstore.Retriever

Instance Constructors

Value Members

Deprecated Value Members

Inherited from blobstore.Retriever

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Retriever

class Retriever extends blobstore.Retriever

Instance Constructors

Value Members

Deprecated Value Members

Inherited from blobstore.Retriever

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Retriever