net.sf.pipet.api
Class InputOutputModule

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

All Implemented Interfaces:

ModuleInterface

public abstract class InputOutputModule
extends SimpleInputOutputModule

Abstract base class for a PipeT module. Subclasses must provide a title and a description via the constructor, and implement run(java.io.InputStream[], java.io.OutputStream, net.sf.pipet.api.ModuleAttributes, net.sf.qxs.messenger.Messenger).

Since:

1.2.8

Nested Class Summary

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

ModuleInterface.ModuleConfigurator, ModuleInterface.ModuleInstance

Field Summary

Fields inherited from class net.sf.pipet.api.SimpleInputOutputModule

INPUT_NAME, OUTPUT_NAME

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

ATT_PIPELINE_NAME, FAIL_CONFIGURATOR, UI_GUI, UI_NONINTERACTIVE

Constructor Summary

InputOutputModule(String title, String description)

InputOutputModule(String title, String description, String input_type, String output_type)

Method Summary

boolean	run(InputStream[] iss, OutputStream os, ModuleAttributes atts, net.sf.qxs.messenger.Messenger messenger) Runs the module in a pipeline.
abstract boolean	run(InputStream is, OutputStream os, ModuleAttributes atts, net.sf.qxs.messenger.Messenger messenger)

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

createInstance, getDescription, getInputPipeTypes, getInputType, getOutputPipeTypes, getOutputType, getTitle

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

getInstallationConfigurator, getPipelineConfigurator, getRuntimeConfigurator

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, isAvailable

Methods inherited from class java.lang.Object

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

Constructor Detail

InputOutputModule

public InputOutputModule(String title,
                         String description)

InputOutputModule

public InputOutputModule(String title,
                         String description,
                         String input_type,
                         String output_type)

Method Detail

run

public boolean run(InputStream[] iss,
                   OutputStream os,
                   ModuleAttributes atts,
                   net.sf.qxs.messenger.Messenger messenger)

Description copied from class: SimpleInputOutputModule

Runs the module in a pipeline.

Specified by:

run in class SimpleInputOutputModule

Parameters:

iss - the module's input.

os - the module's output.

atts - parameters for the module.

messenger - a Messenger object for sending messages back to the user.

Returns:

true if the module completed successfully; false otherwise.

run

public abstract boolean run(InputStream is,
                            OutputStream os,
                            ModuleAttributes atts,
                            net.sf.qxs.messenger.Messenger messenger)