edu.illinois.ncsa.datawolf.domain

Class WorkflowStep

java.lang.Object

edu.illinois.ncsa.domain.AbstractBean

edu.illinois.ncsa.datawolf.domain.WorkflowStep

All Implemented Interfaces:

Serializable

public class WorkflowStep
extends AbstractBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowStep() Create a new instance of the workflow step.

Method Summary

Methods

Modifier and Type	Method and Description
Date	getCreateDate() Return the date when the workflow step was created.
Person	getCreator() Return the PersonBean that is the creator of the workflow
WorkflowToolData	getInput(String id) Returns a specific input.
Map<String,String>	getInputs() Returns a map of inputs from the workflow step.
Map<String,WorkflowToolData>	getInputsToolData() Returns a map of id of step's input to the tool's data definition.
WorkflowToolData	getOutput(String id) Returns a specific output.
Map<String,String>	getOutputs() Returns a map of outputs from the workflow step.
Map<String,WorkflowToolData>	getOutputsToolData() Returns a map of id of step's output to the tool's data definition.
WorkflowToolParameter	getParameter(String id) Returns a specific parameter.
Map<String,String>	getParameters() Returns a map of parameters from the workflow step.
String	getTitle() Return the title of the workflow step.
WorkflowTool	getTool() Return the tool for the workflow step.
void	setCreateDate(Date createDate) Sets the date when the workflow step was created.
void	setCreator(Person creator) Sets the PersonBean that represents the creator of the workflow.
void	setInput(String inputid, String outputid) Maps the input of the tool to a specific output generated in another step.
void	setInput(WorkflowToolData input, String outputid) Maps the input of the tool to a specific output generated in another step.
void	setInputs(Map<String,String> inputs)
void	setOutputs(Map<String,String> outputs)
void	setParameters(Map<String,String> parameters)
void	setTitle(String title) Sets the title of the workflow step.
void	setTool(WorkflowTool tool) Sets the tool for the workflow step.

Methods inherited from class edu.illinois.ncsa.domain.AbstractBean

equals, getId, hashCode, isDeleted, setDeleted, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowStep

public WorkflowStep()

Create a new instance of the workflow step.

Method Detail

getTitle

public String getTitle()

Return the title of the workflow step.

Returns:

title of the workflow step.

setTitle

public void setTitle(String title)

Sets the title of the workflow step.

Parameters:

title - sets the title of the workflow step.

getCreateDate

public Date getCreateDate()

Return the date when the workflow step was created.

Returns:

date the workflow step was created.

setCreateDate

public void setCreateDate(Date createDate)

Sets the date when the workflow step was created.

Parameters:

date - sets the date when the workflow step was created.

getCreator

public Person getCreator()

Return the PersonBean that is the creator of the workflow

Returns:

PersonBean that represents the creator

setCreator

public void setCreator(Person creator)

Sets the PersonBean that represents the creator of the workflow.

Parameters:

creator - sets the PersonBean that represents the creator of the workflow.

getTool

public WorkflowTool getTool()

Return the tool for the workflow step.

Returns:

tool for the workflow step.

setTool

public void setTool(WorkflowTool tool)

Sets the tool for the workflow step. This will also generate a new map that uniquely defines the outputs of this step.

Parameters:

t - sets the tool for the workflow step.

getOutputs

public Map<String,String> getOutputs()

Returns a map of outputs from the workflow step. This maps a specific output to an unique id. The unique id can be used by another step as input. This allows the same tool to be used multiple times with unique values.

Returns:

the mapping from workflow tool output dataId to an unique id.

setOutputs

public void setOutputs(Map<String,String> outputs)

getOutputsToolData

public Map<String,WorkflowToolData> getOutputsToolData()

Returns a map of id of step's output to the tool's data definition.

Returns:

map of id of step's output to the tool's data definition.

getOutput

public WorkflowToolData getOutput(String id)

Returns a specific output. The output returned is based on the unique id generated for the outputs of the tool for this step.

Parameters:

id - the unique id for this step for the outputs generated by the tool.

Returns:

the output data definition for this tool.

Throws:

IllegalArgumentException - throws IllegalArgumentException if the output is not found.

getInputs

public Map<String,String> getInputs()

Returns a map of inputs from the workflow step. This maps a specific input to an unique id. The unique id is generated by another step in the workflow and points to a dataset. This allows the same tool to be used multiple times with unique values.

Returns:

the mapping from tool inputs to unique id's generated by other steps.

setInputs

public void setInputs(Map<String,String> inputs)

getInputsToolData

public Map<String,WorkflowToolData> getInputsToolData()

Returns a map of id of step's input to the tool's data definition.

Returns:

map of id of step's input to the tool's data definition.

getInput

public WorkflowToolData getInput(String id)

Returns a specific input. The input returned is based on the unique id generated for the outputs of the tool for another step.

Parameters:

id - the unique id for another step for the outputs generated by the tool.

Returns:

the input data definition for this tool.

Throws:

IllegalArgumentException - throws IllegalArgumentException if the input is not found.

setInput

public void setInput(WorkflowToolData input,
            String outputid)

Maps the input of the tool to a specific output generated in another step.

Parameters:

input - the input of the tool that will be mapped.

outputid - the unique id generated as output by another step.

setInput

public void setInput(String inputid,
            String outputid)

Maps the input of the tool to a specific output generated in another step.

Parameters:

input - the input of the tool that will be mapped.

outputid - the unique id generated as output by another step.

getParameters

public Map<String,String> getParameters()

Returns a map of parameters from the workflow step. This maps a specific parameter to an unique id. This allows the same tool to be used multiple times with unique values.

Returns:

the mapping from tool parameter to unique id's.

setParameters

public void setParameters(Map<String,String> parameters)

getParameter

public WorkflowToolParameter getParameter(String id)

Returns a specific parameter. The parameter returned is based on the unique id generated for the parameters of this step.

Parameters:

id - the unique id for this step for the parameter generated by the tool.

Returns:

the parameter data definition for this tool.

Throws:

IllegalArgumentException - throws IllegalArgumentException if the parameter is not found.