de.dfki.lt.sdl
Interface IModule

All Known Implementing Classes:
chunkiermrs_de, chunkiermrs_en, Modules, rmrsmerge, SproutModules, SproutModulesDomDomEncapsulated, SproutModulesText, SproutModulesTextDomEncapsulated, SproutModulesTextFile, SproutModulesTextXml, SproutModulesTextXmlEncapsulated, SproutModulesXml, SproutModulesXmlFile, SproutModulesXmlXml, SproutModulesXmlXmlEncapsulated, XsltModules, XsltModulesDocumentNode, XsltModulesDomDomEncapsulated, XsltModulesDomStringEncapsulated, XsltModulesSourceString, XsltModulesStringDomEncapsulated, XsltModulesStringString, XsltModulesStringStringEncapsulated

public interface IModule

this is the interface which every module (may it be global or local composite) MUST fulfill!!

Since:
JDK 1.3
See Also:
IMediator, Mediators, Modules, ModuleRunError, ModuleClearError, ModuleInitError

Method Summary
 void clear()
           
 java.lang.Object getInput()
          returns the input of the module
 java.lang.Object getOutput()
          returns the output of the module which has been computed through the use of run()
 void init(java.lang.String[] initArgs)
          init() initializes the module, specifying an array of init arguments which the module has to interpret
 java.lang.Object run(java.lang.Object input)
          run(_) MUST realize the computation of the module; this unary method must be distinguished from the nullary method run() in the Runnable interface; note that run(_) is NOT forced to set its input nor its output field and should usually avoid this!!
 java.lang.Object setInput(java.lang.Object input)
          sets the input of the module to parameter input and returns input
 java.lang.Object setOutput(java.lang.Object output)
          sets the output of the module to parameter output and returns output
 

Method Detail

clear

void clear()
           throws ModuleClearError
Throws:
ModuleClearError

init

void init(java.lang.String[] initArgs)
          throws ModuleInitError
init() initializes the module, specifying an array of init arguments which the module has to interpret

Throws:
ModuleInitError

run

java.lang.Object run(java.lang.Object input)
                     throws ModuleRunError
run(_) MUST realize the computation of the module; this unary method must be distinguished from the nullary method run() in the Runnable interface; note that run(_) is NOT forced to set its input nor its output field and should usually avoid this!!

Throws:
ModuleRunError

setInput

java.lang.Object setInput(java.lang.Object input)
sets the input of the module to parameter input and returns input


getInput

java.lang.Object getInput()
returns the input of the module


setOutput

java.lang.Object setOutput(java.lang.Object output)
sets the output of the module to parameter output and returns output


getOutput

java.lang.Object getOutput()
returns the output of the module which has been computed through the use of run()