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 validation
Definition Classes
processing
package scalatest
Definition Classes
validation
Accumulator
AggregatedLongAccumulator
DefaultJsonSerializers
DoubleAccumulator
Failed
Feature
GeoJson
Geometry
IncompatibleAccumulatorOpException
JsonDeserializer
JsonSerializer
LineString
LongAccumulator
Metrics
MultiLineString
MultiPoint
MultiPolygon
Outcome
Point
Polygon
Position
Report
Serialization
Skipped
Succeeded
Suite
SuiteCompiler
SuiteLike
Suites
TestCaseDetails
TestCaseStats
TestContext
TestStats
TestSuiteResult
TestSuiteStats
Transformations

com.here.platform.data.processing.validation

SuiteCompiler

class SuiteCompiler[TestData] extends Serializable

Runs a suite or a collection of suites object and produces the output payloads encoding the test Report and Metrics.

TestData: The parametric type of the data under test.

Linear Supertypes

Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SuiteCompiler
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new SuiteCompiler(suite: SuiteLike[TestData], metricsLayer: Id = Layer.Id("metrics"), reportLayer: Id = Layer.Id("report"), suiteReportLayerMapping: Map[String, Id] = Map.empty, stripSucceeded: Boolean = true)(implicit reportSerializer: Serializer[Report], metricsSerializer: Serializer[Metrics])
suite
The suite or collection of suites to be run.
metricsLayer
Layer ID for the metrics partitions. Defaults to "metrics"
reportLayer
Layer ID for the test report. Defaults to "report".
suiteReportLayerMapping
Per-suite overrides for the reportLayer. This parameter can be used to publish test-reports of specific test-suites in specific layers.
stripSucceeded
Filters out all details about succeeded test-cases from the final report. If this parameter is true, only test-report partitions that contain at least one failed test-case are published. Metrics partitions, instead, are not affected, and always contain the information about both failed and succeeded test-cases. Use this to reduce the amount of data published in the output to the bare minimum required to perform a post-test investigation. Defaults to true.
reportSerializer
Serialization.Serializer for the generated Report partitions.
metricsSerializer
Serialization.Serializer for the generated Metrics partitions.

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()
def compile(data: TestData): Map[Id, Payload]
Compiles one instance of TestData, by running all test-suites and encoding the generated Reports and Metrics.
Compiles one instance of TestData, by running all test-suites and encoding the generated Reports and Metrics.
This method is typically called from com.here.platform.data.processing.driver.deltasets.transformations.Stateless.mapValues, com.here.platform.data.processing.driver.deltasets.transformations.Stateless.mapValuesWithKey, com.here.platform.data.processing.driver.deltasets.transformations.Stateful.mapValuesWithResolver and followed by one of the publish transformation in Transformations.
data
The data under test.
returns
the output payloads, indexed by output layer ID.
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
val metricsLayer: Id
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()
val outLayers: Set[Id]
All output layers this SuiteCompiler publishes in.
All output layers this SuiteCompiler publishes in. It includes the report layers and the metrics layer.
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

SuiteCompiler

class SuiteCompiler[TestData] extends Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SuiteCompiler

class SuiteCompiler[TestData] extends Serializable

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

SuiteCompiler