Package fr.ens.biologie.genomique.eoulsan.modules

Class DesignModule

java.lang.Object
fr.ens.biologie.genomique.eoulsan.modules.AbstractModule
fr.ens.biologie.genomique.eoulsan.modules.DesignModule
All Implemented Interfaces:
Module
public class DesignModule extends AbstractModule
This class define a design module.
Since:
2.0
Author:
Laurent Jourdren

  • Field Details

  • Constructor Details

    • DesignModule

      public DesignModule(Design design, CheckerModule checkeModule)
      Constructor.
      Parameters:
      design - design
      checkeModule - the checker module instance

  • Method Details

    • getName

      public String getName()
      Description copied from interface: Module
      Get the name of the module.
      Returns:
      the name of the module

    • getVersion

      public fr.ens.biologie.genomique.kenetre.util.Version getVersion()
      Description copied from interface: Module
      Get version of the Module.
      Returns:
      a Version object with the version of the Module

    • getOutputPorts

      public OutputPorts getOutputPorts()
      Description copied from interface: Module
      Get the output data format.
      Specified by:
      getOutputPorts in interface Module
      Overrides:
      getOutputPorts in class AbstractModule
      Returns:
      an set with DataFormat or null if the module does not produce any output data

    • getParallelizationMode

      public ParallelizationMode getParallelizationMode()
      Description copied from interface: Module
      Get the parallelization mode of the module.
      Specified by:
      getParallelizationMode in interface Module
      Overrides:
      getParallelizationMode in class AbstractModule
      Returns:
      a ParallelizationMode enum

    • configure

      public void configure(StepConfigurationContext context, Set<Parameter> stepParameters) throws EoulsanException
      Description copied from interface: Module
      Set the parameters of the step to configure the module.
      Specified by:
      configure in interface Module
      Overrides:
      configure in class AbstractModule
      Parameters:
      context - configuration context. The context can be null for generator steps
      stepParameters - parameters of the step
      Throws:
      EoulsanException - if a parameter is invalid

    • execute

      public TaskResult execute(TaskContext context, TaskStatus status)
      Description copied from interface: Module
      Execute a task step.
      Parameters:
      context - Execution context
      status - of the task
      Returns:
      a TaskResult object