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

Class CheckerModule

java.lang.Object

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

fr.ens.biologie.genomique.eoulsan.modules.CheckerModule

All Implemented Interfaces:

Module

public class CheckerModule
extends AbstractModule

This class is a module that launch checkers.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODULE_NAME

Constructor Summary

Constructors

Constructor	Description
CheckerModule()	Public constructor.

Method Summary

Modifier and Type	Method	Description
static void	configureChecker(DataFormat format, Set<Parameter> parameters)	This method allow to configure a checker from the configure method of other steps, that's why this method is static.
TaskResult	execute(TaskContext context, TaskStatus status)	Execute a task step.
InputPorts	getInputPorts()	Get the input data format.
String	getName()	Get the name 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

configure, getChecker, getDescription, getOutputPorts, 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

CheckerModule

public CheckerModule()

Public constructor.

Method Detail

configureChecker

public static void configureChecker(DataFormat format,
                                    Set<Parameter> parameters)

This method allow to configure a checker from the configure method of other steps, that's why this method is static.

Parameters:

format - checker format to configure

parameters - parameter of the checker

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

getInputPorts

public InputPorts getInputPorts()

Description copied from interface: Module

Get the input data format.

Specified by:

getInputPorts in interface Module

Overrides:

getInputPorts in class AbstractModule

Returns:

a set with DataFormat or null if the module does not any need input format

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