Interface Step
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractStep
,CommandStep
public interface Step extends Serializable
This interface define a step of the workflow.- Since:
- 2.0
- Author:
- Laurent Jourdren
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Step.DiscardOutput
This enum define the value of the discard output attribute of the step tag in the Eoulsan workflow file.static class
Step.StepState
This enum define the states of the steps.static class
Step.StepType
This enum define the type of step.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Checker
getChecker()
Get Checker.String
getId()
Get step id.InputPorts
getInputPorts()
Get the input ports of the step.String
getModuleName()
Get the module name.int
getNumber()
Get the unique numerical identifier of the step.OutputPorts
getOutputPorts()
Get the output ports of the step.Set<Parameter>
getParameters()
Get the parameter of the step.int
getRequiredMemory()
Get the required memory for the step.int
getRequiredProcessors()
Get the required processors for the step.Step.StepState
getState()
Get the state of the step.String
getStepVersion()
Get the step version required by user.Step.StepType
getType()
Get the type of the step.Workflow
getWorkflow()
Get the workflow of the step.boolean
isSkip()
Test if the step must be skipped
-
-
-
Method Detail
-
getWorkflow
Workflow getWorkflow()
Get the workflow of the step.- Returns:
- the workflow of the step
-
getNumber
int getNumber()
Get the unique numerical identifier of the step.- Returns:
- the number of the step
-
getId
String getId()
Get step id.- Returns:
- the step id
-
isSkip
boolean isSkip()
Test if the step must be skipped- Returns:
- true if the step must be skipped
-
getType
Step.StepType getType()
Get the type of the step.- Returns:
- the type of the step;
-
getModuleName
String getModuleName()
Get the module name.- Returns:
- the module object
-
getStepVersion
String getStepVersion()
Get the step version required by user.- Returns:
- a string with the version of the step required by the user
-
getParameters
Set<Parameter> getParameters()
Get the parameter of the step.- Returns:
- a Set with the parameters of the step
-
getRequiredMemory
int getRequiredMemory()
Get the required memory for the step.- Returns:
- the required memory of the step in MB or -1 if the default setting must be used
-
getRequiredProcessors
int getRequiredProcessors()
Get the required processors for the step.- Returns:
- the required processors count for the step in MB or -1 if the default setting must be used
-
getInputPorts
InputPorts getInputPorts()
Get the input ports of the step.- Returns:
- the input ports of the step
-
getOutputPorts
OutputPorts getOutputPorts()
Get the output ports of the step.- Returns:
- the output ports of the step
-
getState
Step.StepState getState()
Get the state of the step.- Returns:
- the state of the step
-
getChecker
Checker getChecker()
Get Checker.- Returns:
- the checker for the step
-
-