trait RefTreeCompiler[T] extends InputLayers with InputOptPartitioner with ResolveInFn with CompileInFn[T] with OutputLayers with OutputOptPartitioner with CompileOutFn[T]
A RefTreeCompiler allows full and incremental compilation with complex reference structures. A condition is that all references of a layer can be calculated purely from the source data of this layer using a resolve function, which just gets the meta data of one partition as an input. The structure of the references has to be predefined in a reftree.RefTree object.
Apart from the reference resolution pre-phase described above, the compilation itself is split in two phases, front-end and backend, as in other compilers, similar to MapGroupCompiler.
In the first phase, compileIn from reftree.CompileInFn is called for every partition,
with the full list of meta data for all of its referenced partitions. This
method returns one or more values of type T for every impacted output partition.
The compileIn function for the first phase of the compilation is defined in traits that extend reftree.CompileInFn. One of these need to be mixed in, like reftree.CompileInFnWithRefs or reftree.CompileInFnWithRefsReturnsReferences.
In the second phase, a method from one of the CompileOutFn traits is called for every output partition
where the first phase provided at least one element of T. Elements coming from various
input partitions are grouped together and provided as input of compilation for each output partition.
- T
The custom type of the values passed between front-end and back-end
- Note
The implementation must be scala.Serializable as this is copied to workers and run inside Spark map functions.
- See also
traits mixed in for more details
- Alphabetic
- By Inheritance
- RefTreeCompiler
- CompileOutFn
- OutputOptPartitioner
- OutputLayers
- CompileInFn
- ResolveInFn
- Serializable
- Serializable
- InputOptPartitioner
- InputLayers
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
compileInFnDefined(): Unit
Must be overridden as final by all subclasses, to block the mixin of different interfaces in the same compiler class.
Must be overridden as final by all subclasses, to block the mixin of different interfaces in the same compiler class.
- Definition Classes
- CompileInFn
-
abstract
def
compileOutFnDefined(): Unit
Must be overridden as final by all subclasses, to block the mixin of different interfaces in the same compiler class and to assure that at least one child interface is mixed in.
Must be overridden as final by all subclasses, to block the mixin of different interfaces in the same compiler class and to assure that at least one child interface is mixed in.
- Attributes
- protected
- Definition Classes
- CompileOutFn
-
abstract
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
- InputLayers
-
abstract
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
- InputOptPartitioner
-
abstract
def
outLayers: Set[Id]
Layers to be produced by the compiler.
Layers to be produced by the compiler.
- Definition Classes
- OutputLayers
-
abstract
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
- OutputOptPartitioner
-
abstract
def
refStructure: RefTree
The refStructure defines the maximum reference tree of the source layers.
The refStructure defines the maximum reference tree of the source layers.
- See also
com.here.platform.data.processing.compiler.reftree.RefTree for details.
-
abstract
def
resolveFn(src: (InKey, InMeta)): Map[RefName, Set[InKey]]
Resolves the list of partitions in all the reference target layers based on the a source partition.
Resolves the list of partitions in all the reference target layers based on the a source partition. The returned com.here.platform.data.processing.compiler.reftree.RefTree.RefName values for the references must be aligned with the values in the com.here.platform.data.processing.compiler.RefTreeCompiler.refStructure.
- src
the source partition key and metadata
- Definition Classes
- ResolveInFn
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()
-
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()
-
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()
-
final
val
outCatalogId: Id
Identifier for the output catalog.
Identifier for the output catalog.
- Definition Classes
- OutputLayers
-
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()