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

Class RequirementInstallerModule

java.lang.Object

fr.ens.biologie.genomique.eoulsan.modules.AbstractModule

fr.ens.biologie.genomique.eoulsan.modules.RequirementInstallerModule

All Implemented Interfaces:

Module

public class RequirementInstallerModule
extends AbstractModule

This class allow to install a requirement.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODULE_NAME

Constructor Summary

Constructors

Constructor	Description
RequirementInstallerModule()

Method Summary

Modifier and Type	Method	Description
void	configure(StepConfigurationContext context, Set<Parameter> stepParameters)	Set the parameters of the step to configure the module.
TaskResult	execute(TaskContext context, TaskStatus status)	Execute a task step.
String	getName()	Get the name of the module.
ParallelizationMode	getParallelizationMode()	Get the parallelization mode of the module.
fr.ens.biologie.genomique.kenetre.util.Version	getVersion()	Get version of the Module.

Methods inherited from class fr.ens.biologie.genomique.eoulsan.modules.AbstractModule

getChecker, getDescription, getInputPorts, getOutputPorts, getRequiredEoulsanVersion, getRequirements

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

Constructor Detail

RequirementInstallerModule

public RequirementInstallerModule()

Method Detail

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

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