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

Class ExecutorArguments

  • public class ExecutorArguments
extends Object
    This class contains arguments for the Executor.
    Since:
    2.0
    Author:
    Laurent Jourdren

    • Constructor Detail

      • ExecutorArguments

        public ExecutorArguments()
        Public constructor.

      • ExecutorArguments

        public ExecutorArguments​(long millisSinceEpoch)
        Public constructor.
        Parameters:
        millisSinceEpoch - creation time of the job

      • ExecutorArguments

        public ExecutorArguments​(File workflowFile,
                         File designFile)
        Public constructor.
        Parameters:
        workflowFile - workflow file
        designFile - design file

    • Method Detail

      • getLocalWorkingPathname

        public final String getLocalWorkingPathname()
        Get the local working path.
        Returns:
        Returns the local working path

      • getHadoopWorkingPathname

        public final String getHadoopWorkingPathname()
        Get the Hadoop working path.
        Returns:
        Returns the local working path

      • getJobPathname

        public final String getJobPathname()
        Get the job path.
        Returns:
        Returns the job Path

      • getTaskPathname

        public final String getTaskPathname()
        Get the task path.
        Returns:
        Returns the task Path

      • getOutputPathname

        public final String getOutputPathname()
        Get the output path.
        Returns:
        Returns the output Path

      • getDesignPathname

        public final String getDesignPathname()
        Get the design file path.
        Returns:
        the design file path

      • getWorkflowPathname

        public final String getWorkflowPathname()
        Get the workflow file path.
        Returns:
        the workflow file path

      • getTemporaryPathname

        public final String getTemporaryPathname()
        Get the temporary directory path.
        Returns:
        the temporary directory file path

      • getDataPathname

        public final String getDataPathname()
        Get the data directory path.
        Returns:
        the temporary directory file path

      • getJobDescription

        public final String getJobDescription()
        Get the job description.
        Returns:
        the job description

      • getJobEnvironment

        public final String getJobEnvironment()
        Get the job environment.
        Returns:
        the job environment

      • getJobId

        public final String getJobId()
        Get the job id.
        Returns:
        the job id

      • getJobUUID

        public final String getJobUUID()

      • getCreationTime

        public final long getCreationTime()
        Get the creation time of the job.
        Returns:
        the creation time of the context in milliseconds since epoch (1.1.1970)

      • setLocalWorkingPathname

        public final void setLocalWorkingPathname​(String localWorkingPath)
        Set the local working path.
        Parameters:
        localWorkingPath - The local working path to set

      • setHadoopWorkingPathname

        public final void setHadoopWorkingPathname​(String hadoopWorkingPath)
        Set the local working path.
        Parameters:
        hadoopWorkingPath - The local working path to set

      • setJobPathname

        public final void setJobPathname​(String jobPath)
        Set the job path
        Parameters:
        jobPath - The log path to set

      • setTaskPathname

        public final void setTaskPathname​(String taskPath)
        Set the task path
        Parameters:
        taskPath - The task path to set

      • setOutputPathname

        public final void setOutputPathname​(String outputPath)
        Set the output path
        Parameters:
        outputPath - The output path to set

      • setDesignPathname

        public final void setDesignPathname​(String designPathname)
        Set the design file path.
        Parameters:
        designPathname - The design path to set

      • setWorkflowPathname

        public final void setWorkflowPathname​(String workflowPathname)
        Set the workflow file path.
        Parameters:
        workflowPathname - The workflow file path to set

      • setTemporaryPathname

        public final void setTemporaryPathname​(String temporaryPathname)
        Set the temporary directory path.
        Parameters:
        temporaryPathname - The temporary directory path to set

      • setDataPathname

        public final void setDataPathname​(String dataPathname)
        Set the data directory path.
        Parameters:
        dataPathname - The data directory path to set

      • setJobDescription

        public final void setJobDescription​(String jobDescription)
        Set job description.
        Parameters:
        jobDescription - job description

      • setJobEnvironment

        public final void setJobEnvironment​(String jobEnvironment)
        Set job environment.
        Parameters:
        jobEnvironment - job environment

      • openParamFile

        public InputStream openParamFile()
                          throws IOException
        Open the Workflow file.
        Returns:
        an InputStream with the content of the workflow file
        Throws:
        IOException - if an error occurs while opening the workflow file

      • openDesignFile

        public InputStream openDesignFile()
                           throws IOException
        Open the design file.
        Returns:
        an InputStream with the content of the design file
        Throws:
        IOException - if an error occurs while opening the design file

      • logPath

        public URI logPath​(String logFilename)
        Create the log path.
        Parameters:
        logFilename - log file name
        Returns:
        a String with an URI for the log