Package fr.ens.biologie.genomique.aozan.aozan3.recipe

Class Step

java.lang.Object

fr.ens.biologie.genomique.aozan.aozan3.recipe.Step

public class Step
extends Object

This class define a step of the recipe.

Since:

3.0

Author:

Laurent Jourdren

Constructor Summary

Constructors

Constructor	Description
Step(Recipe recipe, String stepName, String processorName, String sinkName, Configuration conf, RunConfigurationProvider runConfProvider, RunIdGenerator runIdGenerator)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<DataTypeFilter>	getInputRequirements()	Get the input requirements of the processor.
String	getName()	Get the name of the step.
String	getProcessorName()	Get the name of the processor of the step.
void	init()	Initialize the step.
DataProcessor.ProcessResult	process(InputData inputData)	Process input data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Step

public Step(Recipe recipe,
            String stepName,
            String processorName,
            String sinkName,
            Configuration conf,
            RunConfigurationProvider runConfProvider,
            RunIdGenerator runIdGenerator)

Constructor.

Parameters:

recipe - recipe of the step

stepName - step name

processorName - name of the processor

sinkName - sink name

conf - step configuration

runConfProvider - run configuration to use

Method Detail

getName

public String getName()

Get the name of the step.

Returns:

the name of the step

getProcessorName

public String getProcessorName()

Get the name of the processor of the step.

Returns:

the name of the processor of thestep

init

public void init()
          throws Aozan3Exception

Initialize the step.

Throws:

Aozan3Exception - if an error occurs while initializing the step

getInputRequirements

public Set<DataTypeFilter> getInputRequirements()

Get the input requirements of the processor.

Returns:

a set with input requirements

process

public DataProcessor.ProcessResult process(InputData inputData)
                                    throws Aozan3Exception

Process input data.

Parameters:

inputData - input data to process

Returns:

a process result

Throws:

Aozan3Exception - if an error occurs while executing the step