Package fr.ens.biologie.genomique.eoulsan.core

Interface TaskContext

All Superinterfaces:

StepConfigurationContext

All Known Implementing Classes:

TaskContextImpl

public interface TaskContext
extends StepConfigurationContext

This interface define the context of a step.

Since:

1.0

Author:

Laurent Jourdren

Method Summary

Modifier and Type	Method	Description
long	getContextCreationTime()	Get the creation time of the context.
String	getContextName()	Get the context name.
Data	getInputData(DataFormat format)	Get the input data for an input DataType and a Sample.
Data	getInputData(String portName)	Get the input data for a port name and a Sample.
Data	getOutputData(DataFormat format, Data origin)	Get the output data for an input DataType and a Sample.
Data	getOutputData(DataFormat format, String dataName)	Get the output data for an input DataType and a Sample.
Data	getOutputData(DataFormat format, String dataName, int part)	Get the output data for an input DataType and a Sample.
Data	getOutputData(String portName, Data origin)	Get the output data for a port name and a Sample.
Data	getOutputData(String portName, String dataName)	Get the output data for a port name and a Sample.
Data	getOutputData(String portName, String dataName, int part)	Get the output data for a port name and a Sample.
Workflow	getWorkflow()	Get the workflow description
void	setContextName(String contextName)	Set the context name.

Methods inherited from interface fr.ens.biologie.genomique.eoulsan.core.StepConfigurationContext

getCommandAuthor, getCommandDescription, getCommandName, getCurrentStep, getDesignFile, getGenericLogger, getJobDescription, getJobDirectory, getJobEnvironment, getJobHost, getJobId, getJobUUID, getLocalTempDirectory, getLogger, getOutputDirectory, getRuntime, getSettings, getStepOutputDirectory, getWorkflowFile

Method Detail

getContextName

String getContextName()

Get the context name.

Returns:

a String with the context name

setContextName

void setContextName(String contextName)

Set the context name.

Parameters:

contextName - the name of the context

getContextCreationTime

long getContextCreationTime()

Get the creation time of the context.

Returns:

the creation time of the context in milliseconds since epoch (1.1.1970)

getWorkflow

Workflow getWorkflow()

Get the workflow description

Returns:

the workflow description

getInputData

Data getInputData(DataFormat format)

Get the input data for an input DataType and a Sample.

Parameters:

format - the DataFormat of the source

Returns:

a String with the pathname

getInputData

Data getInputData(String portName)

Get the input data for a port name and a Sample.

Parameters:

portName - the name of the port

Returns:

a String with the pathname

getOutputData

Data getOutputData(DataFormat format,
                   String dataName)

Get the output data for an input DataType and a Sample.

Parameters:

format - the DataFormat of the source

dataName - the name of the data

Returns:

a String with the pathname

getOutputData

Data getOutputData(DataFormat format,
                   String dataName,
                   int part)

Get the output data for an input DataType and a Sample.

Parameters:

format - the DataFormat of the source

dataName - the name of the data

part - data part

Returns:

a String with the pathname

getOutputData

Data getOutputData(DataFormat format,
                   Data origin)

Get the output data for an input DataType and a Sample.

Parameters:

format - the DataFormat of the source

origin - origin of the new data

Returns:

a String with the pathname

getOutputData

Data getOutputData(String portName,
                   String dataName)

Get the output data for a port name and a Sample.

Parameters:

portName - the name of the port

dataName - the name of the data

Returns:

a String with the pathname

getOutputData

Data getOutputData(String portName,
                   String dataName,
                   int part)

Get the output data for a port name and a Sample.

Parameters:

portName - the name of the port

dataName - the name of the data

part - data part

Returns:

a String with the pathname

getOutputData

Data getOutputData(String portName,
                   Data origin)

Get the output data for a port name and a Sample.

Parameters:

portName - the name of the port

origin - origin of the new data

Returns:

a String with the pathname