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 catalog
Java bindings for the catalog package.
Java bindings for the catalog package.
Definition Classes
java
package partition
Definition Classes
catalog
package partitioning
Definition Classes
catalog
package utils
Definition Classes
catalog
Catalog
CatalogFactory
CatalogLight
CatalogLightFactory
CatalogView
CatalogViewAtVersion
CatalogViewSinceVersion
CommitPart
CommitToken
Configuration
EmptyCatalogView
LayerConfiguration
NonEmptyCatalogView
WrappedAbstractType

com.here.platform.data.processing.java.catalog

CatalogLight

trait CatalogLight extends AnyRef

The interface to access basic catalog properties and perform the catalog operations that do not involve metadata or Spark.

Note: This a Java friendly wrapper of com.here.platform.data.processing.catalog.CatalogLight.

Linear Supertypes

AnyRef, Any

Known Subclasses

Catalog, CatalogImpl, CatalogLightImpl

Ordering

Alphabetic
By Inheritance

Inherited

CatalogLight
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def abortCommit(token: CommitToken): Unit
Aborts a commit being prepared.
Aborts a commit being prepared.
token
The token identifying the commit to abort
abstract def finishCommit(token: CommitToken, parts: List[CommitPart]): Unit
Completes a multipart commit.
Completes a multipart commit.
token
The token obtained when startCommit was called to start this commit.
parts
All the commit parts obtained from calls made to partialCommit as part of this commit.
abstract def hrn: HRN
The HRN (HERE Resource Name) of the catalog.
The HRN (HERE Resource Name) of the catalog. It is a resource descriptor that provides a globally unique handle for a catalog in the sense of an instance.
abstract def id: String
The unique identifier for the catalog, that is added to every com.here.platform.data.processing.java.catalog.partition.Key returned by the query APIs and is used by the commit API for logging and statistics generation.
abstract def queryConfiguration(): Configuration
Queries the current configuration of the catalog.
Queries the current configuration of the catalog.
returns
The current configuration of the catalog.
abstract def queryDependencies(version: Version): List[Dependency]
Queries the dependencies for a particular catalog version.
Queries the dependencies for a particular catalog version.
version
The version of the catalog for which dependencies will be queried.
returns
The dependencies of the catalog version.
abstract def queryLatestVersion(): BaseVersion
Queries the latest version of the catalog.
Queries the latest version of the catalog.
returns
The latest catalog version available in the Data API, or com.here.platform.data.processing.catalog.utils.EmptyCatalog otherwise.
abstract def queryLayerVersions(version: Version): Map[String, Version]
Queries the latest version for each of the catalog layers.
Queries the latest version for each of the catalog layers. This is the version of the most recent event affecting that layer, either because a partition was changed and/or deleted in that version.
For some layers, this version may be older than the catalog's overall version, particularly if those layers did not change, but other layers have changed.
version
The version for which the catalog's layers are queried.
returns
The latest version for each of the catalog's layers.
Note
In case a layer has never changed since catalog creation, 0 is returned.
abstract def queryPartitionChangeHistory(version: Version, layer: String, partition: Name, direction: catalog.Catalog.ChangeHistoryDirection.Value): List[Change]
Queries metadata history for the selected partition.
Queries metadata history for the selected partition.
This query is done directly in the Driver, and the metadata is returned. You can query up to 100 changes with one call.
version
The version from which to begin the change history search.
layer
The layer that contains the partition.
partition
The partition to query the change history for.
direction
Specifies the direction in which to lookup the history: forward or backward.
returns
A com.here.platform.data.processing.java.catalog.partition.Change object containing the partition size and checksum.
Note
This method is scheduled to be deprecated in a future release. Only supported by the Datastore1 implementation.
abstract def querySinglePartitions(version: Version, layer: String, partitions: Set[Name]): Map[Key, Meta]
Queries metadata for the selected partitions.
Queries metadata for the selected partitions.
This query is done directly in the Driver, and the metadata is returned. You can query up to 100 partitions with one call.
version
The version at which the catalog is queried for partitions.
layer
The layer that contains the partitions being queried.
partitions
The partition names that should be queried.
returns
The queried metadata, for partitions that have content in the catalog at the specified version. Partitions not present in the catalog at the specified version are not returned.
Note
This method is only intended to be used internally, by the library. When implementing your compiler, you are encouraged to use queryAll/queryChanges instead, as these methods are implemented in a distributed way.
abstract def retriever: Retriever
Exposes the Retriever for this catalog.
Exposes the Retriever for this catalog. The returned object can be captured in Spark functions and transmitted to worker nodes.
abstract def startCommit(baseVersion: BaseVersion, dependencies: List[Dependency]): CommitToken
Starts a new multipart commit on top of an existing version or an empty catalog.
Starts a new multipart commit on top of an existing version or an empty catalog.
baseVersion
The current version of the catalog in the Data API. This information is required to prevent race conditions if the version is changed elsewhere, in another process, while we are preparing data for the commit. If the catalog is empty, use com.here.platform.data.processing.catalog.utils.EmptyCatalog.
dependencies
The upstream dependencies for this commit.
returns
A new multipart commit token representing the commit in progress.
abstract def tokenFromString(s: String): CommitToken
Create a commit token for the catalog given its string representation.
abstract def tokenToString(t: CommitToken): String
Return the string representation of a commit token.

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

CatalogLight

trait CatalogLight extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CatalogLight

trait CatalogLight extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

CatalogLight