com.chemaxon.overlap.cli.util.pipeline

Class CollectStorage

java.lang.Object

com.chemaxon.overlap.cli.util.pipeline.CollectStorage

All Implemented Interfaces:

PipelineStep

public class CollectStorage
extends Object
implements PipelineStep

Collect a master property storage. A MasterStorage is a column oriented storage of potentially missing elements.

Constructor Summary

Constructors

Constructor and Description
CollectStorage()

Method Summary

Modifier and Type	Method and Description
static void	addToLinenote(LinenoteBuilder<PipelineStep> linenoteBuilder) Append linenote spec.
void	addToPipeline(PipelineContext pipeline) Wire step into the pipeline.
void	close() Close the step.
void	init() Initialize the step.
void	mms(boolean b)
void	mmsImportOpts(String o)
void	setMasterStorageCounsumer(Consumer<MasterStorage> msc)
void	setProgressiveSerialization(ProgressiveSerialization p)
String	toString()
void	type(String t)

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectStorage

public CollectStorage()

Method Detail

type

public void type(String t)

mms

public void mms(boolean b)

mmsImportOpts

public void mmsImportOpts(String o)

setProgressiveSerialization

public void setProgressiveSerialization(ProgressiveSerialization p)

setMasterStorageCounsumer

public void setMasterStorageCounsumer(Consumer<MasterStorage> msc)

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.

init

public void init()
          throws Exception

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:

Exception - In case of initialization failure

close

public void close()
           throws Exception

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:

Exception - might be propagated from underlying IO

toString

public String toString()

Overrides:

toString in class Object

addToLinenote

public static void addToLinenote(LinenoteBuilder<PipelineStep> linenoteBuilder)

Append linenote spec.

Parameters:

linenoteBuilder - Target builder