Package fr.ens.biologie.genomique.eoulsan.requirements

Class RserveRequirement

java.lang.Object

fr.ens.biologie.genomique.eoulsan.requirements.AbstractRequirement

fr.ens.biologie.genomique.eoulsan.requirements.RserveRequirement

All Implemented Interfaces:

Requirement

public class RserveRequirement
extends AbstractRequirement

This class define a Rserve server requirement.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUIREMENT_NAME

Fields inherited from class fr.ens.biologie.genomique.eoulsan.requirements.AbstractRequirement

NAME_PARAMETER

Constructor Summary

Constructors

Constructor	Description
RserveRequirement()

Method Summary

Modifier and Type	Method	Description
void	configure(Set<Parameter> parameters)	Configure the requirement.
String	getName()	The name of the requirement.
Set<Parameter>	getParameters()	Get the parameters of the requirement
void	install(Progress progress)	Install the requirement.
boolean	isAvailable()	Test if the requirement is available.
static Requirement	newRserveRequirement(String rserveServerName)	Create a new mandatory Rserve requirement.
static Requirement	newRserveRequirement(String rserveServerName, boolean optional)	Create a new Rserve requirement.
String	toString()

Methods inherited from class fr.ens.biologie.genomique.eoulsan.requirements.AbstractRequirement

isInstallable, isOptional

Methods inherited from class java.lang.Object

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

Field Details

REQUIREMENT_NAME

public static final String REQUIREMENT_NAME

See Also:

• Constant Field Values

Constructor Details

RserveRequirement

public RserveRequirement()

Method Details

getName

public String getName()

Description copied from interface: Requirement

The name of the requirement.

Returns:

the name of the requirement

configure

public void configure(Set<Parameter> parameters)
               throws EoulsanException

Description copied from interface: Requirement

Configure the requirement.

Specified by:

configure in interface Requirement

Overrides:

configure in class AbstractRequirement

Parameters:

parameters - the parameters of the requirement

Throws:

EoulsanException - if an error occurs while configuring the requirement

getParameters

public Set<Parameter> getParameters()

Description copied from interface: Requirement

Get the parameters of the requirement

Specified by:

getParameters in interface Requirement

Overrides:

getParameters in class AbstractRequirement

Returns:

a set of parameters

isAvailable

public boolean isAvailable()

Description copied from interface: Requirement

Test if the requirement is available.

Returns:

true if he requirement is optional

install

public void install(Progress progress)
             throws EoulsanException

Description copied from interface: Requirement

Install the requirement.

Parameters:

progress - Progress object

Throws:

EoulsanException - if the requirement cannot be installed

newRserveRequirement

public static Requirement newRserveRequirement(String rserveServerName)

Create a new mandatory Rserve requirement.

Parameters:

rserveServerName - the Rserve server name

Returns:

a new Requirement object

newRserveRequirement

public static Requirement newRserveRequirement(String rserveServerName,
 boolean optional)

Create a new Rserve requirement.

Parameters:

rserveServerName - the Rserve server name

optional - true if the Rserve server is a mandatory requirement

Returns:

a new Requirement object

toString

public String toString()

Overrides:

toString in class Object