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

Class DummyGeneratorModule

java.lang.Object

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

fr.ens.biologie.genomique.eoulsan.modules.generators.DummyGeneratorModule

All Implemented Interfaces:

Module

public class DummyGeneratorModule
extends AbstractModule

This class implements a dummy generator module that create an empty file.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODULE_NAME

Constructor Summary

Constructors

Constructor	Description
DummyGeneratorModule()

Method Summary

Modifier and Type	Method	Description
TaskResult	execute(TaskContext context, TaskStatus status)	Execute a task step.
String	getDescription()	Get the description of the module
String	getName()	Get the name of the module.
OutputPorts	getOutputPorts()	Get the output data format.
fr.ens.biologie.genomique.kenetre.util.Version	getVersion()	Get version of the Module.

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

configure, getChecker, getInputPorts, getParallelizationMode, 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

DummyGeneratorModule

public DummyGeneratorModule()

Method Detail

getName

public String getName()

Description copied from interface: Module

Get the name of the module.

Returns:

the name of the module

getDescription

public String getDescription()

Description copied from interface: Module

Get the description of the module

Specified by:

getDescription in interface Module

Overrides:

getDescription in class AbstractModule

Returns:

the description 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

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