PluginModule (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.deepzoom.workflow.PluginModule

All Implemented Interfaces:: IModule

public class PluginModule
extends Object
implements IModule

TODO

Author:: Aivar Grislis

Field Summary

Fields
Modifier and Type Field and Description

static String CLASSNAME

static String PLUGIN

Fields
Modifier and Type	Field and Description
`static String`	`CLASSNAME`
`static String`	`PLUGIN`

Constructor Summary

Constructors
Constructor and Description
`PluginModule()`
`PluginModule(Class<?> pluginClass)` Create an instance for a given plugin class.
`PluginModule(String pluginClassName)` Create an instance for a given plugin class name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`fromXML(String xml)` Restores component from XML string representation.
`String[]`	`getInputNames()` Gets input image names.
`IPluginLauncher`	`getLauncher()` Gets associated launcher
`String`	`getName()` Gets name of component.
`String[]`	`getOutputNames()` Gets output names.
`void`	`input(ItemWrapper image)` Furnish input image.
`void`	`input(ItemWrapper image, String name)` Furnish input image
`void`	`setName(String name)` Sets name of component.
`void`	`setOutputListener(IOutputListener listener)` Listen for output image.
`void`	`setOutputListener(String name, IOutputListener listener)` Listen for output image.
`String`	`toXML()` Saves component as XML string representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PLUGIN
```
public static final String PLUGIN
```
    See Also:
    
    Constant Field Values
  - CLASSNAME
```
public static final String CLASSNAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PluginModule
```
public PluginModule()
```
  - PluginModule
```
public PluginModule(String pluginClassName)
             throws PluginClassException
```
    Create an instance for a given plugin class name.
    
    Parameters:
    
    pluginClassName -
    
    Throws:
    
    PluginClassException
  - PluginModule
```
public PluginModule(Class<?> pluginClass)
```
    Create an instance for a given plugin class.
    
    Parameters:
    
    pluginClass -
- Method Detail
  - getName
```
public String getName()
```
    Gets name of component.
    
    Specified by:
    
    getName in interface IModule
    
    Returns:
  - setName
```
public void setName(String name)
```
    Sets name of component.
    
    Specified by:
    
    setName in interface IModule
    
    Parameters:
    
    name -
  - getLauncher
```
public IPluginLauncher getLauncher()
```
    Description copied from interface: IModule
    
    Gets associated launcher
    
    Specified by:
    
    getLauncher in interface IModule
    
    Returns:
    
    launcher
  - toXML
```
public String toXML()
```
    Saves component as XML string representation.
    
    Specified by:
    
    toXML in interface IModule
    
    Returns:
  - fromXML
```
public boolean fromXML(String xml)
```
    Restores component from XML string representation.
    
    Specified by:
    
    fromXML in interface IModule
    
    Parameters:
    
    xml -
    
    Returns:
    
    whether successfully parsed
  - getInputNames
```
public String[] getInputNames()
```
    Gets input image names.
    
    Specified by:
    
    getInputNames in interface IModule
    
    Returns:
  - getOutputNames
```
public String[] getOutputNames()
```
    Gets output names.
    
    Specified by:
    
    getOutputNames in interface IModule
    
    Returns:
  - input
```
public void input(ItemWrapper image)
```
    Furnish input image.
    
    Specified by:
    
    input in interface IModule
    
    Parameters:
    
    image -
  - input
```
public void input(ItemWrapper image,
                  String name)
```
    Furnish input image
    
    Specified by:
    
    input in interface IModule
    
    Parameters:
    
    image -
    
    name -
  - setOutputListener
```
public void setOutputListener(IOutputListener listener)
```
    Listen for output image.
    
    Specified by:
    
    setOutputListener in interface IModule
    
    Parameters:
    
    listener -
  - setOutputListener
```
public void setOutputListener(String name,
                              IOutputListener listener)
```
    Listen for output image.
    
    Specified by:
    
    setOutputListener in interface IModule
    
    Parameters:
    
    name -
    
    listener -

Class PluginModule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLUGIN

CLASSNAME

Constructor Detail

PluginModule

PluginModule

PluginModule

Method Detail

getName

setName

getLauncher

toXML

fromXML

getInputNames

getOutputNames

input

input

setOutputListener

setOutputListener