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

Class HDFSDataDownloadModule

java.lang.Object

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

fr.ens.biologie.genomique.eoulsan.modules.mgmt.upload.HDFSDataDownloadModule

All Implemented Interfaces:

Module

public class HDFSDataDownloadModule
extends AbstractModule

This class define a download module that retrieve data from HDFS at the end of an analysis.

Since:

1.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATAFORMATS_TO_DOWNLOAD_SETTING	Key in the settings to use to save the list of DataFormat of the files to download.
static final String	MODULE_NAME	Module name.
static final String	NO_HDFS_DOWNLOAD	Key in the settings to use to disable the downloads.

Constructor Summary

Constructors

Constructor	Description
HDFSDataDownloadModule()

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	getDescription()	Get the description of the module
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

getChecker, getInputPorts, getOutputPorts, getParallelizationMode, getRequiredEoulsanVersion, getRequirements

Methods inherited from class java.lang.Object

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

Field Details

DATAFORMATS_TO_DOWNLOAD_SETTING

public static final String DATAFORMATS_TO_DOWNLOAD_SETTING

Key in the settings to use to save the list of DataFormat of the files to download.

See Also:

• Constant Field Values

NO_HDFS_DOWNLOAD

public static final String NO_HDFS_DOWNLOAD

Key in the settings to use to disable the downloads.

See Also:

• Constant Field Values

MODULE_NAME

public static final String MODULE_NAME

Module name.

See Also:

• Constant Field Values

Constructor Details

HDFSDataDownloadModule

public HDFSDataDownloadModule()

Method Details

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

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