net.sf.pipet.api
Class AbstractModule

java.lang.Object
  net.sf.pipet.api.AbstractModule

All Implemented Interfaces:

ModuleInterface

Direct Known Subclasses:

VersionedModule

public abstract class AbstractModule
extends Object
implements ModuleInterface

The purpose of this class is to improve version stability. All modules should subclass this abstract class.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.pipet.api.ModuleInterface

ModuleInterface.ModuleConfigurator, ModuleInterface.ModuleInstance

Field Summary

Fields inherited from interface net.sf.pipet.api.ModuleInterface

ATT_PIPELINE_NAME, FAIL_CONFIGURATOR, UI_GUI, UI_NONINTERACTIVE

Constructor Summary

AbstractModule()

Method Summary

String	getAPIVersionString()
Map<String,ParameterType<?>>	getGlobalParameters(ModuleAttributes atts)
Collection<String>	getInputPipeNames(ModuleAttributes atts) Deprecated.
protected static Map<String,ParameterType<?>>	getLeftOver(Map<String,ParameterType<?>> params, ModuleAttributes atts)
Collection<String>	getOutputPipeNames(ModuleAttributes atts) Deprecated.
Map<String,ParameterType<?>>	getPipelineParameters(ModuleAttributes atts)
protected static Map<String,String>	getPipeTypes(Collection<String> collection) Deprecated.
Map<String,ParameterType<?>>	getRuntimeParameters(ModuleAttributes atts)
String	getTitle(ModuleAttributes atts) Returns the title (a short description) of the module.
boolean	isAvailable()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.pipet.api.ModuleInterface

createInstance, getDescription, getInputPipeTypes, getInstallationConfigurator, getOutputPipeTypes, getPipelineConfigurator, getRuntimeConfigurator

Constructor Detail

AbstractModule

public AbstractModule()

Method Detail

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface ModuleInterface

getAPIVersionString

public String getAPIVersionString()

Specified by:

getAPIVersionString in interface ModuleInterface

getInputPipeNames

@Deprecated
public final Collection<String> getInputPipeNames(ModuleAttributes atts)
                                           throws ResourceException

Deprecated.

Specified by:

getInputPipeNames in interface ModuleInterface

Throws:

ResourceException

getOutputPipeNames

@Deprecated
public final Collection<String> getOutputPipeNames(ModuleAttributes atts)
                                            throws ResourceException

Deprecated.

Specified by:

getOutputPipeNames in interface ModuleInterface

Throws:

ResourceException

getPipeTypes

@Deprecated
protected static Map<String,String> getPipeTypes(Collection<String> collection)

Deprecated.

getTitle

public String getTitle(ModuleAttributes atts)
                throws ResourceException

Description copied from interface: ModuleInterface

Returns the title (a short description) of the module.

Specified by:

getTitle in interface ModuleInterface

Parameters:

atts - The module data.

Throws:

ResourceException

getLeftOver

protected static Map<String,ParameterType<?>> getLeftOver(Map<String,ParameterType<?>> params,
                                                          ModuleAttributes atts)

getGlobalParameters

public Map<String,ParameterType<?>> getGlobalParameters(ModuleAttributes atts)

Specified by:

getGlobalParameters in interface ModuleInterface

getPipelineParameters

public Map<String,ParameterType<?>> getPipelineParameters(ModuleAttributes atts)

Specified by:

getPipelineParameters in interface ModuleInterface

getRuntimeParameters

public Map<String,ParameterType<?>> getRuntimeParameters(ModuleAttributes atts)
                                                  throws ResourceException

Specified by:

getRuntimeParameters in interface ModuleInterface

Throws:

ResourceException