AnnotatingPass (Nemo Project 0.4 API)

java.lang.Object
- org.apache.nemo.common.pass.Pass
- - org.apache.nemo.compiler.optimizer.pass.compiletime.CompileTimePass
  - - org.apache.nemo.compiler.optimizer.pass.compiletime.annotating.AnnotatingPass

All Implemented Interfaces:

java.util.function.Function<IRDAG,IRDAG>

Direct Known Subclasses:

AggressiveSpeculativeCloningPass, CompressionPass, DefaultDataPersistencePass, DefaultDataStorePass, DefaultEdgeDecoderPass, DefaultEdgeEncoderPass, DefaultParallelismPass, DefaultScheduleGroupPass, DisaggregationEdgeDataStorePass, DuplicateEdgeGroupSizePass, LambdaPass, LargeShuffleAnnotatingPass, PipeTransferForAllEdgesPass, ResourceLocalityPass, ResourceSitePass, ResourceSlotPass, ShuffleEdgePushPass, SkewAnnotatingPass, TransientResourceDataTransferPass, TransientResourcePriorityPass, UpfrontCloningPass, XGBoostPass
```
public abstract class AnnotatingPass
extends CompileTimePass
```
A compile-time pass that annotates the IR DAG with execution properties. It is ensured by the compiler that the shape of the IR DAG itself is not modified by an AnnotatingPass.

Constructor Summary

Constructors
Constructor Description

AnnotatingPass(java.lang.Class<? extends AnnotatingPass> cls)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Set<java.lang.Class<? extends ExecutionProperty>>`	`getExecutionPropertiesToAnnotate()`	Getter for the execution properties to annotate through the pass.
`java.util.Set<java.lang.Class<? extends ExecutionProperty>>`	`getPrerequisiteExecutionProperties()`	Getter for prerequisite execution properties.

Methods inherited from class org.apache.nemo.common.pass.Pass
addCondition, getCondition

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function
andThen, apply, compose

- Constructor Detail
  - AnnotatingPass
```
public AnnotatingPass(java.lang.Class<? extends AnnotatingPass> cls)
```
    Constructor.
    
    Parameters:
    
    cls - the annotating pass class.
- Method Detail
  - getExecutionPropertiesToAnnotate
```
public final java.util.Set<java.lang.Class<? extends ExecutionProperty>> getExecutionPropertiesToAnnotate()
```
    Getter for the execution properties to annotate through the pass.
    
    Returns:
    
    key of execution properties to annotate through the pass.
  - getPrerequisiteExecutionProperties
```
public final java.util.Set<java.lang.Class<? extends ExecutionProperty>> getPrerequisiteExecutionProperties()
```
    Description copied from class: CompileTimePass
    
    Getter for prerequisite execution properties.
    
    Specified by:
    
    getPrerequisiteExecutionProperties in class CompileTimePass
    
    Returns:
    
    set of prerequisite execution properties.