net.sf.pipet.api
Class DefaultModuleInterface

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

All Implemented Interfaces:

ModuleInterface

Direct Known Subclasses:

SimpleInputOutputModule

public abstract class DefaultModuleInterface
extends VersionedModule

A simple ModuleInterface, which provides a default implementation for most methods. This class is provided to reduce the effort of creating a new module.

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

DefaultModuleInterface()

Method Summary

Map<String,String>	getInputPipeTypes(ModuleAttributes atts) Returns an empty set.
ModuleInterface.ModuleConfigurator	getInstallationConfigurator(int interface_type) Returns null.
Map<String,String>	getOutputPipeTypes(ModuleAttributes atts) Returns an empty set.
ModuleInterface.ModuleConfigurator	getPipelineConfigurator(int interface_type) Returns null.
ModuleInterface.ModuleConfigurator	getRuntimeConfigurator(int interface_type) Returns null.

Methods inherited from class net.sf.pipet.api.VersionedModule

getAPIVersionString

Methods inherited from class net.sf.pipet.api.AbstractModule

getGlobalParameters, getInputPipeNames, getLeftOver, getOutputPipeNames, getPipelineParameters, getPipeTypes, getRuntimeParameters, getTitle, 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

Constructor Detail

DefaultModuleInterface

public DefaultModuleInterface()

Method Detail

getOutputPipeTypes

public Map<String,String> getOutputPipeTypes(ModuleAttributes atts)

Returns an empty set.

Parameters:

atts - The module attributes.

getInputPipeTypes

public Map<String,String> getInputPipeTypes(ModuleAttributes atts)

Returns an empty set.

Parameters:

atts - The module data.

getInstallationConfigurator

public ModuleInterface.ModuleConfigurator getInstallationConfigurator(int interface_type)

Returns null.

Parameters:

interface_type - the type of user interface, which is one of: ModuleInterface.UI_NONINTERACTIVE, ModuleInterface.UI_GUI.

Returns:

a ModuleConfigurator object, or null if the module is not install-time configurable.

getPipelineConfigurator

public ModuleInterface.ModuleConfigurator getPipelineConfigurator(int interface_type)

Returns null.

Parameters:

interface_type - the type of user interface, which is one of: ModuleInterface.UI_NONINTERACTIVE, ModuleInterface.UI_GUI.

Returns:

a ModuleConfigurator object, or null if the module is not pipeline configurable.

getRuntimeConfigurator

public ModuleInterface.ModuleConfigurator getRuntimeConfigurator(int interface_type)

Returns null.

Parameters:

interface_type - the type of user interface, which is one of: ModuleInterface.UI_NONINTERACTIVE, ModuleInterface.UI_GUI.

Returns:

a ModuleInterface.ModuleConfigurator object, or null if the module is not runtime configurable.