com.chemaxon.overlap.cli

Class PipelineRunner

java.lang.Object

com.chemaxon.overlap.cli.PipelineRunner

All Implemented Interfaces:

PipelineContext

public class PipelineRunner
extends Object
implements PipelineContext

Responsible for composing the pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipelineRunner.Connection<T>
static class	PipelineRunner.IO<T>
static class	PipelineRunner.IOType

Constructor Summary

Constructors

Constructor and Description
PipelineRunner()

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> inputSetter) 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.
List<PipelineStep>	getSteps()
void	run()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PipelineRunner

public PipelineRunner()

Method Detail

getSteps

public List<PipelineStep> getSteps()

addStep

public void addStep(PipelineStep step)

Specified by:

addStep in interface PipelineContext

addIteratorOutput

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

Description copied from interface: PipelineContext

Register an output with an iterator of values.

Specified by:

addIteratorOutput in interface PipelineContext

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

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

Description copied from interface: PipelineContext

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.

Specified by:

addDelayedSingleOutput in interface PipelineContext

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

addSingleShotOutput

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

Description copied from interface: PipelineContext

Register an output with a single value.

Specified by:

addSingleShotOutput in interface PipelineContext

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

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

Description copied from interface: PipelineContext

Register an input with a single value.

Specified by:

addSingleInput in interface PipelineContext

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.

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

addRepeatedInput

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

Description copied from interface: PipelineContext

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

Specified by:

addRepeatedInput in interface PipelineContext

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

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

Description copied from interface: PipelineContext

Register a secondary output providing metrics.

Specified by:

addStatefulMetricOutput in interface PipelineContext

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

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

Description copied from interface: PipelineContext

Add stateless transformation.

Specified by:

addStatelessTransformation in interface PipelineContext

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

getLastStep

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

Description copied from interface: PipelineContext

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

Specified by:

getLastStep in interface PipelineContext

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

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

Description copied from interface: PipelineContext

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.

Specified by:

addMasterStorageBuilder in interface PipelineContext

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.

run

public void run()