AbstractPlugin (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.deepzoom.workflow.plugin.AbstractPlugin

All Implemented Interfaces:

IPlugin, IPluginInternal
```
public abstract class AbstractPlugin
extends Object
implements IPluginInternal, IPlugin
```
Abstract base class for plugin. Starts up plugin processing, gets and puts images for the plugin.

Author:

Aivar Grislis

Constructor Summary

Constructors
Constructor and Description

AbstractPlugin()

Constructors
Constructor and Description
`AbstractPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ItemWrapper`	`get()` Gets the default input image from previous in chain.
`ItemWrapper`	`get(String inName)` Gets a named input image from previous in chain.
`void`	`put(ItemWrapper image)` Puts the default output image to next in chain (if any).
`void`	`put(String outName, ItemWrapper image)` Puts named output image to next in chain (if any).
`void`	`start(Map<String,ItemWrapper> inputImages, Map<String,String> outputNames)` Starts up processing.

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

Methods inherited from interface loci.deepzoom.workflow.plugin.IPlugin
process

- Constructor Detail
  - AbstractPlugin
```
public AbstractPlugin()
```
- Method Detail
  - start
```
public void start(Map<String,ItemWrapper> inputImages,
                  Map<String,String> outputNames)
```
    Starts up processing. Called from plugin launcher.
    
    Specified by:
    
    start in interface IPluginInternal
    
    Parameters:
    
    inputImages - maps each input name to an image
    
    outputNames - maps each output name to a unique input name for the next chained plugin.
  - get
```
public ItemWrapper get()
```
    Gets the default input image from previous in chain. Called from subclass.
    
    Specified by:
    
    get in interface IPlugin
    
    Returns:
    
    image
  - get
```
public ItemWrapper get(String inName)
```
    Gets a named input image from previous in chain. Called from subclass.
    
    Specified by:
    
    get in interface IPlugin
    
    Parameters:
    
    inName -
    
    Returns:
    
    image
  - put
```
public void put(ItemWrapper image)
```
    Puts the default output image to next in chain (if any). Called from subclass.
    
    Specified by:
    
    put in interface IPlugin
    
    Parameters:
    
    image -
  - put
```
public void put(String outName,
                ItemWrapper image)
```
    Puts named output image to next in chain (if any). Called from subclass.
    
    Specified by:
    
    put in interface IPlugin
    
    Parameters:
    
    outName -
    
    image -

Class AbstractPlugin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface loci.deepzoom.workflow.plugin.IPlugin

Constructor Detail

AbstractPlugin

Method Detail

start

get

get

put

put