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

Class StepConfigurationContextImpl

java.lang.Object

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

All Implemented Interfaces:

StepConfigurationContext

public class StepConfigurationContextImpl
extends Object
implements StepConfigurationContext

This class define a concrete implementation of the configuration context of a step.

Since:

2.0

Author:

Laurent Jourdren

Method Summary

Modifier and Type	Method	Description
String	getCommandAuthor()	Get the command author.
String	getCommandDescription()	Get command description.
String	getCommandName()	Get the command name.
Step	getCurrentStep()	Get the current step.
DataFile	getDesignFile()	Get the design file path.
fr.ens.biologie.genomique.kenetre.log.GenericLogger	getGenericLogger()	Get the generic logger.
DataFile	getHadoopWorkingDirectory()	Get the Hadoop working directory.
DataFile	getJarPathname()	Get the application jar file.
String	getJobDescription()	Get the job description.
DataFile	getJobDirectory()	Get the job directory.
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.
File	getLocalTempDirectory()	Get local temporary directory.
DataFile	getLocalWorkingDirectory()	Get the local working directory.
Logger	getLogger()	Get the logger.
DataFile	getOutputDirectory()	Get the output path.
AbstractEoulsanRuntime	getRuntime()	Get EoulsanRuntime.
Settings	getSettings()	Get Eoulsan settings.
DataFile	getStepOutputDirectory()	Get the step working directory.
DataFile	getTaskOutputDirectory()	Get the task output directory.
DataFile	getWorkflowFile()	Get the workflow file path.

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 Hadoop working directory.

Returns:

Returns the Hadoop working directory

getJobDirectory

public DataFile getJobDirectory()

Get the job directory.

Specified by:

getJobDirectory in interface StepConfigurationContext

Returns:

Returns the job directory

getTaskOutputDirectory

public DataFile getTaskOutputDirectory()

Get the task output directory.

Returns:

Returns the task output directory

getOutputDirectory

public DataFile getOutputDirectory()

Description copied from interface: StepConfigurationContext

Get the output path.

Specified by:

getOutputDirectory in interface StepConfigurationContext

Returns:

Returns the output Path

getStepOutputDirectory

public DataFile getStepOutputDirectory()

Description copied from interface: StepConfigurationContext

Get the step working directory.

Specified by:

getStepOutputDirectory in interface StepConfigurationContext

Returns:

Returns the step working directory

getJobId

public String getJobId()

Description copied from interface: StepConfigurationContext

Get the job id.

Specified by:

getJobId in interface StepConfigurationContext

Returns:

the job id

getJobHost

public String getJobHost()

Description copied from interface: StepConfigurationContext

Get the host of the job.

Specified by:

getJobHost in interface StepConfigurationContext

Returns:

a string with the host of the job

getDesignFile

public DataFile getDesignFile()

Description copied from interface: StepConfigurationContext

Get the design file path.

Specified by:

getDesignFile in interface StepConfigurationContext

Returns:

the design file path

getWorkflowFile

public DataFile getWorkflowFile()

Description copied from interface: StepConfigurationContext

Get the workflow file path.

Specified by:

getWorkflowFile in interface StepConfigurationContext

Returns:

the workflow file path

getJarPathname

public DataFile getJarPathname()

Get the application jar file.

Returns:

Returns the jar file

getJobUUID

public String getJobUUID()

Description copied from interface: StepConfigurationContext

Get the UUID of the job.

Specified by:

getJobUUID in interface StepConfigurationContext

Returns:

the job UUID

getJobDescription

public String getJobDescription()

Description copied from interface: StepConfigurationContext

Get the job description.

Specified by:

getJobDescription in interface StepConfigurationContext

Returns:

the job description

getJobEnvironment

public String getJobEnvironment()

Description copied from interface: StepConfigurationContext

Get the job environment.

Specified by:

getJobEnvironment in interface StepConfigurationContext

Returns:

the job environment

getCommandName

public String getCommandName()

Description copied from interface: StepConfigurationContext

Get the command name.

Specified by:

getCommandName in interface StepConfigurationContext

Returns:

the command name

getCommandDescription

public String getCommandDescription()

Description copied from interface: StepConfigurationContext

Get command description.

Specified by:

getCommandDescription in interface StepConfigurationContext

Returns:

the command description

getCommandAuthor

public String getCommandAuthor()

Description copied from interface: StepConfigurationContext

Get the command author.

Specified by:

getCommandAuthor in interface StepConfigurationContext

Returns:

the command author

getCurrentStep

public Step getCurrentStep()

Description copied from interface: StepConfigurationContext

Get the current step.

Specified by:

getCurrentStep in interface StepConfigurationContext

Returns:

the current Step or null if no Step is currently running.

getRuntime

public AbstractEoulsanRuntime getRuntime()

Description copied from interface: StepConfigurationContext

Get EoulsanRuntime.

Specified by:

getRuntime in interface StepConfigurationContext

Returns:

the EoulsanRuntime

getSettings

public Settings getSettings()

Description copied from interface: StepConfigurationContext

Get Eoulsan settings.

Specified by:

getSettings in interface StepConfigurationContext

Returns:

the Settings

getLogger

public Logger getLogger()

Description copied from interface: StepConfigurationContext

Get the logger.

Specified by:

getLogger in interface StepConfigurationContext

Returns:

the logger

getGenericLogger

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

Description copied from interface: StepConfigurationContext

Get the generic logger.

Specified by:

getGenericLogger in interface StepConfigurationContext

Returns:

the generic logger

getLocalTempDirectory

public File getLocalTempDirectory()

Description copied from interface: StepConfigurationContext

Get local temporary directory.

Specified by:

getLocalTempDirectory in interface StepConfigurationContext

Returns:

the local temporary directory