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

Class UploadModule

java.lang.Object

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

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

All Implemented Interfaces:

Module

Direct Known Subclasses:

HadoopUploadModule, LocalUploadModule

public abstract class UploadModule
extends AbstractModule

This class define a abstract module class for files uploading.

Since:

1.0

Author:

Laurent Jourdren

Constructor Summary

Constructors

Constructor	Description
UploadModule(DataFile destination)	Public constructor.

Method Summary

Modifier and Type	Method	Description
TaskResult	execute(TaskContext context, TaskStatus status)	Execute a task step.
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, getInputPorts, getOutputPorts, getParallelizationMode, getRequiredEoulsanVersion, getRequirements

Methods inherited from class java.lang.Object

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

Constructor Details

UploadModule

public UploadModule(DataFile destination)

Public constructor.

Parameters:

destination - destination of the uploaded files

Method Details

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

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