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 catalog
Contains an abstract Scala interface for accessing catalogs from Spark.
Contains an abstract Scala interface for accessing catalogs from Spark.
Use the com.here.platform.data.processing.catalog.Catalog factory methods to obtain instances.

Definition Classes
processing
package datastore

Definition Classes
catalog
package utils
Classes representing catalog versions.
Classes representing catalog versions.

Definition Classes
catalog
AppCredentials
AppInfo
Catalog
CatalogFactory
CatalogLight
CatalogLightFactory
CatalogMetrics
CatalogNullMetrics
CatalogProxy
CatalogView
CatalogViewAtVersion
CatalogViewLight
CatalogViewSinceVersion
Configuration
Dependency
DependencyType
DirectDependency
EmptyCatalogView
EndpointLocatorSettings
Implicits
IndirectDependency
Layer
LayerConfiguration
NonEmptyCatalogView
Partition
Partitioning
QueryPersistence
QueryReuse
ServiceSupport

com.here.platform.data.processing.catalog

CatalogView

sealed trait CatalogView extends CatalogViewLight

Provides a view on a specific version of a catalog. The view may reference a non-existing version EmptyCatalogView, an existing version of a catalog CatalogViewAtVersion or an existing version of catalog with a reference to a previous version CatalogViewSinceVersion.

Linear Supertypes

CatalogViewLight, AnyRef, Any

Known Subclasses

CatalogViewAtVersion, CatalogViewSinceVersion, EmptyCatalogView, NonEmptyCatalogView

Ordering

Alphabetic
By Inheritance

Inherited

CatalogView
CatalogViewLight
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract val catalog: Catalog
The catalog which is encapsulated by this view.
The catalog which is encapsulated by this view.

Definition Classes
CatalogView → CatalogViewLight
abstract def querySinglePartitions(layer: Id, partitions: Set[Name]): Map[Key, Meta]
Queries metadata for the given partitions.
Queries metadata for the given partitions.
You can query up to 100 partitions with one call.
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 version referenced by this catalog view. Partitions not present are not returned.

Definition Classes
CatalogViewLight
Note
Querying large amounts of metadata using this function is expensive and should be avoided. Instead, CatalogView.queryAll(...) should be used whenever possible.

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 empty(partitioner: Partitioner[Key] = catalog.defaultPartitioner): RDD[(Key, Meta)]
Creates a partitioned empty RDD of (Key, Meta) in compliance with other methods of this component.
Creates a partitioned empty RDD of (Key, Meta) in compliance with other methods of this component.
partitioner
The com.here.platform.data.processing.spark.partitioner.Partitioner applied when constructing the RDD returned.
returns
An empty RDD of (Partition.Key, Partition.Meta), which is partitioned according to the partitioner parameter.
def emptyChanges(partitioner: Partitioner[Key] = catalog.defaultPartitioner): RDD[(Key, Change)]
Creates a partitioned empty RDD of (Partition.Key, Partition.Change) in compliance with other methods of this component.
Creates a partitioned empty RDD of (Partition.Key, Partition.Change) in compliance with other methods of this component.
partitioner
The com.here.platform.data.processing.spark.partitioner.Partitioner applied when constructing the RDD returned.
returns
An empty RDD of (Partition.Key, Partition.Change), partitioned according to the partitioner parameter.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
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
AnyRef → Any
Annotations
@native()
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.

Definition Classes
CatalogViewLight
def id: Id
The unique identifier for the catalog, that is added to every Partition.Key returned by the query APIs and is used by the commit API for logging and statistics generation.
The unique identifier for the catalog, that is added to every Partition.Key returned by the query APIs and is used by the commit API for logging and statistics generation.

Definition Classes
CatalogViewLight
See also
Catalog.Id for more details.
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
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
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.

Definition Classes
CatalogViewLight
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

CatalogView

sealed trait CatalogView extends CatalogViewLight

Abstract Value Members

Concrete Value Members

Inherited from CatalogViewLight

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CatalogView 

sealed trait CatalogView extends CatalogViewLight

Abstract Value Members

Concrete Value Members

Inherited from CatalogViewLight

Inherited from AnyRef

Inherited from Any

Ungrouped

CatalogView