com.chemaxon.overlap.cli.util.pipeline

Class Mark

java.lang.Object

com.chemaxon.overlap.cli.util.pipeline.Mark

All Implemented Interfaces:

PipelineStep

public class Mark
extends Object
implements PipelineStep

Mark last node or one of its output. This is a DTO to hold the mark specification.

Constructor Summary

Constructors

Constructor and Description
Mark()

Method Summary

Modifier and Type	Method and Description
static void	addToLinenote(LinenoteBuilder<PipelineStep> linenoteBuilder)
void	addToPipeline(PipelineContext pipeline) Wire step into the pipeline.
void	close() Close the step.
void	init() Initialize the step.
void	name(String l)
void	output(String c)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Mark

public Mark()

Method Detail

name

public void name(String l)

output

public void output(String c)

init

public void init()
          throws FileNotFoundException,
                 IOException

Description copied from interface: PipelineStep

Initialize the step. Open required files, connections, etc. Be prepared to start stream data from now. Contracts:

• This method might not be invoked during the life cycle of an implementing instance.
• Method PipelineStep.addToPipeline(com.chemaxon.overlap.cli.util.pipeline.PipelineContext) will be invoked before this method.
• File presence, possibly validity checking should be done here.
• Values for single inputs are all set from upstream nodes before invoking this method..
• Outputs are queried after this method returned.
• Method PipelineStep.close() is expected to be invoked sometimes later, regardless of possible error(s) thrown.

Specified by:

init in interface PipelineStep

Throws:

FileNotFoundException

IOException

close

public void close()
           throws IOException

Description copied from interface: PipelineStep

Close the step. Close opened files, connections, etc. No further interaction is expected. Method PipelineStep.init() is guaranteed to be invoked before. Note that it is possible that PipelineStep.init() and PipelineStep.close() methods are not invoked during the life cycle of an implementing instance.

Specified by:

close in interface PipelineStep

Throws:

IOException

addToPipeline

public void addToPipeline(PipelineContext pipeline)

Description copied from interface: PipelineStep

Wire step into the pipeline. Contracts:

• Introduce the step using PipelineContext.addStep(com.chemaxon.overlap.cli.util.pipeline.PipelineStep)
• Introduce inputs and outputs. The actual inputs, outputs and their types might depend on the parameterization.
• Invoked before PipelineStep.init().
• Default parameterization is expected to be valid to invoke this method.
• Validity checks based on the parameterization might happen (consistency of the set parameters). Environment (other nodes, file system, etc) based verifications are expected to be executed in PipelineStep.init().
• Apart from interacting with the passed PipelineContext reference this method is side effect free
• Parameterization is expected to be not changed after invoking this method.

Specified by:

addToPipeline in interface PipelineStep

Parameters:

pipeline - Target pipeline.

toString

public String toString()

Overrides:

toString in class Object

addToLinenote

public static void addToLinenote(LinenoteBuilder<PipelineStep> linenoteBuilder)