com.chemaxon.overlap.cli.util.pipeline

Interface PipelineContext

All Known Implementing Classes:

PipelineRunner

public interface PipelineContext

Composes the pipeline.

The possible output types:

• single shot output A single object is produced.
• iterator output Multiple objects of the same type are produced.

The possible input types:

• single input A single object is consumed.

Method Summary

Modifier and Type	Method and Description
<T> void	addDelayedSingleOutput(PipelineStep step, String outputName, String description, Class<T> outputType, Consumer<Consumer<T>> output) Register an output with a single value.
<T> void	addIteratorOutput(PipelineStep step, String outputName, String description, Class<T> outputType, Supplier<Iterator<T>> outputSupplier) Register an output with an iterator of values.
<T> void	addMasterStorageBuilder(PipelineStep step, String inputName, String inputDescription, Class<T> inputType, MasterStorages.MasterStorageBuilder<T> builder) Add a MasterStorage building node.
<T> void	addRepeatedInput(PipelineStep step, String inputName, String description, Class<T> inputType, Consumer<T> inputConsumer) Register an input which accepts repeated values.
<T> void	addSingleInput(PipelineStep step, String inputName, String description, Class<T> inputType, Consumer<T> inputConsumer) Register an input with a single value.
<T> void	addSingleShotOutput(PipelineStep step, String outputName, String description, Class<T> outputType, Supplier<T> outputSupplier) Register an output with a single value.
void	addStatefulMetricOutput(PipelineStep step, String outputName, String description, Supplier<Long> outputSupplier) Register a secondary output providing metrics.
<U,V> void	addStatelessTransformation(PipelineStep step, String inputName, String inputDescription, Class<U> inputType, String outputName, String outputDescription, Class<V> outputType, Function<U,V> transformation) Add stateless transformation.
void	addStep(PipelineStep step)
<T> T	getLastStep(Class<T> stepType) Get last step from the pipeline.

Method Detail

addStep

void addStep(PipelineStep step)

addSingleShotOutput

<T> void addSingleShotOutput(PipelineStep step,
                             String outputName,
                             String description,
                             Class<T> outputType,
                             Supplier<T> outputSupplier)

Register an output with a single value.

Type Parameters:

T - Type of the returned value

Parameters:

step - The involved step

outputName - Short descriptive name of the output

description - Human readable description of the output

outputType - Type of the returned value

outputSupplier - Supplier of the returned value. Will be invoked after PipelineStep.init().

addDelayedSingleOutput

<T> void addDelayedSingleOutput(PipelineStep step,
                                String outputName,
                                String description,
                                Class<T> outputType,
                                Consumer<Consumer<T>> output)

Register an output with a single value. The single value is constructed later during the execution. The output parameter is a Consumer which expects the target Consumer of the output value to be introduced. When no Consumer.accept(java.lang.Object) invocation is made then the specific output value is not necessarily composed.

A typical application is an optional output of a (memory) extensive builder node.

Type Parameters:

T - Type of the returned value

Parameters:

step - The involved step

outputName - Short descriptive name of the output

description - Human readable description of the output

outputType - Type of the returned value

output - Callback to be invoked by the

addIteratorOutput

<T> void addIteratorOutput(PipelineStep step,
                           String outputName,
                           String description,
                           Class<T> outputType,
                           Supplier<Iterator<T>> outputSupplier)

Register an output with an iterator of values.

Type Parameters:

T - Type of the returned value

Parameters:

step - The involved step

outputName - Short descriptive name of the output

description - Human readable description of the output

outputType - Type of the returned value

outputSupplier - Supplier of the returned value. Will be invoked after PipelineStep.init().

addSingleInput

<T> void addSingleInput(PipelineStep step,
                        String inputName,
                        String description,
                        Class<T> inputType,
                        Consumer<T> inputConsumer)

Register an input with a single value.

Type Parameters:

T - Type of the input.

Parameters:

step - The involved step.

inputName - Short descriptive name of the input.

description - Human readable description of the input.

inputType - Type of the expected value.

inputConsumer - Consumer of the input value. Will be invoked before PipelineStep.init() at most once.

addRepeatedInput

<T> void addRepeatedInput(PipelineStep step,
                          String inputName,
                          String description,
                          Class<T> inputType,
                          Consumer<T> inputConsumer)

Register an input which accepts repeated values. The node is considered stateful.

Type Parameters:

T - Type of the input.

Parameters:

step - The involved step.

inputName - Short descriptive name of the input.

description - Human readable description of the input.

inputType - Type of the expected value.

inputConsumer - Consumer of the input value. Will be invoked after PipelineStep.init() zero or multiple times.

addStatefulMetricOutput

void addStatefulMetricOutput(PipelineStep step,
                             String outputName,
                             String description,
                             Supplier<Long> outputSupplier)

Register a secondary output providing metrics.

Parameters:

step - The involved step

outputName - Short descriptive name of the output

description - Human readable description of the output

outputSupplier - Supplier of the returned value. Will be invoked after PipelineStep.init().

addStatelessTransformation

<U,V> void addStatelessTransformation(PipelineStep step,
                                      String inputName,
                                      String inputDescription,
                                      Class<U> inputType,
                                      String outputName,
                                      String outputDescription,
                                      Class<V> outputType,
                                      Function<U,V> transformation)

Add stateless transformation.

Type Parameters:

U - Input type

V - Output type

Parameters:

step - The involved step

inputName - Short descriptive name of the input.

inputDescription - Human readable description of the input.

inputType - Input type

outputName - Short descriptive name of the output

outputDescription - Human readable description of the output

outputType - Output type

transformation -

getLastStep

<T> T getLastStep(Class<T> stepType)
           throws IllegalStateException

Get last step from the pipeline. Typically used with meta Step instances which manipulate a "normal" step.

Type Parameters:

T - Expected type of the last step

Parameters:

stepType - Expected type of the last step

Returns:

Last step with the given type

Throws:

IllegalStateException - when last step type does not match

addMasterStorageBuilder

<T> void addMasterStorageBuilder(PipelineStep step,
                                 String inputName,
                                 String inputDescription,
                                 Class<T> inputType,
                                 MasterStorages.MasterStorageBuilder<T> builder)

Add a MasterStorage building node. This is an order sensitive reduce/collect step which accepts ordered, possibly sparse data. The passed builder is considered an input of the node/step. The output is not specified with this call.

Type Parameters:

T - Input type

Parameters:

step - The involved step

inputName - Short descriptive name of the input.

inputDescription - Human readable description of the input.

inputType - Input type

builder - Input for the builder. Note that MasterStorages.MasterStorageBuilder#build() is invoked before accessing output(s) but the returned instance will be ignored.