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

Class WorkflowContext

java.lang.Object

fr.ens.biologie.genomique.eoulsan.core.workflow.WorkflowContext

All Implemented Interfaces:

Serializable

public class WorkflowContext
extends Object
implements Serializable

This class define the context implementation.

Since:

1.0

Author:

Laurent Jourdren

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
String	getCommandAuthor()	Get the command author.
String	getCommandDescription()	Get command description.
String	getCommandName()	Get the command name.
long	getContextCreationTime()	Get the creation time of the context.
DataFile	getDataRepositoryDirectory()	Get the data repository directory.
DataFile	getDesignFile()	Get the design file.
fr.ens.biologie.genomique.kenetre.log.GenericLogger	getGenericLogger()	Get the generic logger.
DataFile	getHadoopWorkingDirectory()	Get the local working directory.
DataFile	getJarFile()	Get the application jar file.
String	getJobDescription()	Get the job description.
DataFile	getJobDirectory()	Get the job path.
String	getJobEnvironment()	Get the job environment.
String	getJobHost()	Get the host of the job.
String	getJobId()	Get the job id.
String	getJobUUID()	Get the UUID of the job.
DataFile	getLocalWorkingDirectory()	Get the local working directory.
Logger	getLogger()	Get the logger.
DataFile	getOutputDirectory()	Get the output directory.
AbstractEoulsanRuntime	getRuntime()	Get EoulsanRuntime.
Settings	getSettings()	Get Eoulsan settings.
DataFile	getTaskDirectory()	Get the task directory.
Workflow	getWorkflow()	Get the workflow description.
DataFile	getWorkflowFile()	Get the workflow file.
void	setDesignFile(DataFile designFile)	Set the design file.
void	setJarFile(DataFile jarFile)	Set the jar file.
void	setWorkflowFile(DataFile workflowFile)	Set the workflow file.

Methods inherited from class java.lang.Object

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

Method Detail

getLocalWorkingDirectory

public DataFile getLocalWorkingDirectory()

Get the local working directory.

Returns:

Returns the local working path

getHadoopWorkingDirectory

public DataFile getHadoopWorkingDirectory()

Get the local working directory.

Returns:

Returns the local working directory

getOutputDirectory

public DataFile getOutputDirectory()

Get the output directory.

Returns:

Returns the output directory

getJobDirectory

public DataFile getJobDirectory()

Get the job path.

Returns:

Returns the log Path

getTaskDirectory

public DataFile getTaskDirectory()

Get the task directory.

Returns:

Returns the task directory

getDataRepositoryDirectory

public DataFile getDataRepositoryDirectory()

Get the data repository directory.

Returns:

Returns the data repository directory

getJobId

public String getJobId()

Get the job id.

Returns:

the job id

getJobHost

public String getJobHost()

Get the host of the job.

Returns:

a string with the host of the job

getContextCreationTime

public long getContextCreationTime()

Get the creation time of the context.

Returns:

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

getDesignFile

public DataFile getDesignFile()

Get the design file.

Returns:

the design file

getWorkflowFile

public DataFile getWorkflowFile()

Get the workflow file.

Returns:

the workflow file

getJarFile

public DataFile getJarFile()

Get the application jar file.

Returns:

Returns the jar file

getJobUUID

public String getJobUUID()

Get the UUID of the job.

Returns:

the job UUID

getJobDescription

public String getJobDescription()

Get the job description.

Returns:

the job description

getJobEnvironment

public String getJobEnvironment()

Get the job environment.

Returns:

the job environment

getCommandName

public String getCommandName()

Get the command name.

Returns:

the command name

getCommandDescription

public String getCommandDescription()

Get command description.

Returns:

the command description

getCommandAuthor

public String getCommandAuthor()

Get the command author.

Returns:

the command author

getWorkflow

public Workflow getWorkflow()

Get the workflow description.

Returns:

the workflow description

setDesignFile

public void setDesignFile(DataFile designFile)

Set the design file.

Parameters:

designFile - The design file to set

setWorkflowFile

public void setWorkflowFile(DataFile workflowFile)

Set the workflow file.

Parameters:

workflowFile - The workflow file to set

setJarFile

public void setJarFile(DataFile jarFile)

Set the jar file.

Parameters:

jarFile - The jar file to set

getRuntime

public AbstractEoulsanRuntime getRuntime()

Get EoulsanRuntime.

Returns:

the EoulsanRuntime

getSettings

public Settings getSettings()

Get Eoulsan settings.

Returns:

the Settings

getLogger

public Logger getLogger()

Get the logger.

Returns:

the logger

getGenericLogger

public fr.ens.biologie.genomique.kenetre.log.GenericLogger getGenericLogger()

Get the generic logger.

Returns:

the generic logger