WorkFlow (LOCI Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

IModule, IWorkFlow
```
public class WorkFlow
extends Object
implements IWorkFlow
```
Builds a workflow consisting of chained components. A component could also be another workflow. Saves setup as XML file and restores from XML file.

Author:

Aivar Grislis

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DST`
`static String`	`INPUT`
`static String`	`INPUTS`
`static String`	`MODULE`
`static String`	`MODULES`
`static String`	`NAME`
`static String`	`OUTPUT`
`static String`	`OUTPUTS`
`static String`	`SRC`
`static String`	`WIRE`
`static String`	`WIRES`
`static String`	`WORKFLOW`

Constructor Summary

Constructors
Constructor and Description

WorkFlow()

Constructors
Constructor and Description
`WorkFlow()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(IModule component)` Adds a component to the workflow in phase I.
`void`	`clear()` Clears wiring.
`void`	`finalize()` Leftover, un-wired module inputs and outputs become workflow inputs and outputs.
`boolean`	`fromXML(String xml)` Restores chained components from XML string representation.
`String[]`	`getInputNames()` Gets input image names.
`IPluginLauncher`	`getLauncher()` Gets launcher.
`String`	`getName()` Gets name of module.
`String[]`	`getOutputNames()` Gets output names.
`Wire[]`	`getWires()` Gets the current chains.
`void`	`input(ItemWrapper image)` Furnish default input image
`void`	`input(ItemWrapper image, String name)` Furnish named input image
`void`	`quit()` Stops processing.
`void`	`setName(String name)` Sets name of module.
`void`	`setOutputListener(IOutputListener listener)` Listen for default output image.
`void`	`setOutputListener(String name, IOutputListener listener)` Listen for named output image.
`String`	`toXML()` Saves chained components as XML string representation.
`void`	`wire(IModule source, IModule dest)` Chains default output of one component to default input of another.
`void`	`wire(IModule source, IModule dest, String destName)` Chains default output of one component to named input of another.
`void`	`wire(IModule source, String sourceName, IModule dest)` Chains named output of one component to default input of another.
`void`	`wire(IModule source, String sourceName, IModule dest, String destName)` Chains named output of one component to named input of another.
`void`	`wireInput(IModule dest)` Chains default workflow input to default input of component.
`void`	`wireInput(IModule dest, String destName)` Chains default workflow input to named input of component.
`void`	`wireInput(String inName, IModule dest)` Chains named workflow input to default input of component.
`void`	`wireInput(String inName, IModule dest, String destName)` Chains named workflow input to named input of component.
`void`	`wireOutput(IModule source)` Chains default component output to default workflow output.
`void`	`wireOutput(IModule source, String sourceName)` Chains named component output to default workflow output.
`void`	`wireOutput(String outName, IModule source)` Chains default component output to named workflow output.
`void`	`wireOutput(String outName, IModule source, String sourceName)` Chains named component output to named workflow output.

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

- Field Detail
  - WORKFLOW
```
public static final String WORKFLOW
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - MODULES
```
public static final String MODULES
```
    See Also:
    
    Constant Field Values
  - MODULE
```
public static final String MODULE
```
    See Also:
    
    Constant Field Values
  - WIRES
```
public static final String WIRES
```
    See Also:
    
    Constant Field Values
  - WIRE
```
public static final String WIRE
```
    See Also:
    
    Constant Field Values
  - DST
```
public static final String DST
```
    See Also:
    
    Constant Field Values
  - SRC
```
public static final String SRC
```
    See Also:
    
    Constant Field Values
  - INPUTS
```
public static final String INPUTS
```
    See Also:
    
    Constant Field Values
  - INPUT
```
public static final String INPUT
```
    See Also:
    
    Constant Field Values
  - OUTPUTS
```
public static final String OUTPUTS
```
    See Also:
    
    Constant Field Values
  - OUTPUT
```
public static final String OUTPUT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WorkFlow
```
public WorkFlow()
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: IModule
    
    Gets name of module.
    
    Specified by:
    
    getName in interface IModule
  - setName
```
public void setName(String name)
```
    Description copied from interface: IModule
    
    Sets name of module.
    
    Specified by:
    
    setName in interface IModule
  - getLauncher
```
public IPluginLauncher getLauncher()
```
    Gets launcher.
    
    Specified by:
    
    getLauncher in interface IModule
    
    Returns:
    
    launcher
  - getInputNames
```
public String[] getInputNames()
```
    Description copied from interface: IModule
    
    Gets input image names.
    
    Specified by:
    
    getInputNames in interface IModule
  - getOutputNames
```
public String[] getOutputNames()
```
    Description copied from interface: IModule
    
    Gets output names.
    
    Specified by:
    
    getOutputNames in interface IModule
  - fromXML
```
public boolean fromXML(String xml)
```
    Description copied from interface: IWorkFlow
    
    Restores chained components from XML string representation. Accomplishes Phases I-III.
    
    Specified by:
    
    fromXML in interface IModule
    
    Specified by:
    
    fromXML in interface IWorkFlow
    
    Returns:
    
    whether successfully parsed
  - toXML
```
public String toXML()
```
    Description copied from interface: IWorkFlow
    
    Saves chained components as XML string representation. Only after Phase III is complete.
    
    Specified by:
    
    toXML in interface IModule
    
    Specified by:
    
    toXML in interface IWorkFlow
    
    Returns:
  - add
```
public void add(IModule component)
```
    Description copied from interface: IWorkFlow
    
    Adds a component to the workflow in phase I.
    
    Specified by:
    
    add in interface IWorkFlow
  - wire
```
public void wire(IModule source,
                 IModule dest)
```
    Description copied from interface: IWorkFlow
    
    Chains default output of one component to default input of another. Phase II.
    
    Specified by:
    
    wire in interface IWorkFlow
  - wire
```
public void wire(IModule source,
                 String sourceName,
                 IModule dest)
```
    Description copied from interface: IWorkFlow
    
    Chains named output of one component to default input of another. Phase II.
    
    Specified by:
    
    wire in interface IWorkFlow
  - wire
```
public void wire(IModule source,
                 IModule dest,
                 String destName)
```
    Description copied from interface: IWorkFlow
    
    Chains default output of one component to named input of another. Phase II.
    
    Specified by:
    
    wire in interface IWorkFlow
  - wire
```
public void wire(IModule source,
                 String sourceName,
                 IModule dest,
                 String destName)
```
    Description copied from interface: IWorkFlow
    
    Chains named output of one component to named input of another. Phase II.
    
    Specified by:
    
    wire in interface IWorkFlow
  - getWires
```
public Wire[] getWires()
```
    Description copied from interface: IWorkFlow
    
    Gets the current chains. Should be called after Phase II.
    
    Specified by:
    
    getWires in interface IWorkFlow
    
    Returns:
    
    array of chains
  - finalize
```
public void finalize()
```
    Description copied from interface: IWorkFlow
    
    Leftover, un-wired module inputs and outputs become workflow inputs and outputs. Phase II to III.
    
    Specified by:
    
    finalize in interface IWorkFlow
    
    Overrides:
    
    finalize in class Object
  - wireInput
```
public void wireInput(IModule dest)
```
    Description copied from interface: IWorkFlow
    
    Chains default workflow input to default input of component. Phase III.
    
    Specified by:
    
    wireInput in interface IWorkFlow
  - wireInput
```
public void wireInput(IModule dest,
                      String destName)
```
    Description copied from interface: IWorkFlow
    
    Chains default workflow input to named input of component. Phase III.
    
    Specified by:
    
    wireInput in interface IWorkFlow
  - wireInput
```
public void wireInput(String inName,
                      IModule dest)
```
    Description copied from interface: IWorkFlow
    
    Chains named workflow input to default input of component. Phase III.
    
    Specified by:
    
    wireInput in interface IWorkFlow
  - wireInput
```
public void wireInput(String inName,
                      IModule dest,
                      String destName)
```
    Description copied from interface: IWorkFlow
    
    Chains named workflow input to named input of component. Phase III.
    
    Specified by:
    
    wireInput in interface IWorkFlow
  - wireOutput
```
public void wireOutput(IModule source)
```
    Description copied from interface: IWorkFlow
    
    Chains default component output to default workflow output. Phase III.
    
    Specified by:
    
    wireOutput in interface IWorkFlow
  - wireOutput
```
public void wireOutput(IModule source,
                       String sourceName)
```
    Description copied from interface: IWorkFlow
    
    Chains named component output to default workflow output. Phase III.
    
    Specified by:
    
    wireOutput in interface IWorkFlow
  - wireOutput
```
public void wireOutput(String outName,
                       IModule source)
```
    Description copied from interface: IWorkFlow
    
    Chains default component output to named workflow output. Phase III.
    
    Specified by:
    
    wireOutput in interface IWorkFlow
  - wireOutput
```
public void wireOutput(String outName,
                       IModule source,
                       String sourceName)
```
    Description copied from interface: IWorkFlow
    
    Chains named component output to named workflow output. Phase III.
    
    Specified by:
    
    wireOutput in interface IWorkFlow
  - input
```
public void input(ItemWrapper image)
```
    Description copied from interface: IModule
    
    Furnish default input image
    
    Specified by:
    
    input in interface IModule
  - input
```
public void input(ItemWrapper image,
                  String name)
```
    Description copied from interface: IModule
    
    Furnish named input image
    
    Specified by:
    
    input in interface IModule
  - setOutputListener
```
public void setOutputListener(IOutputListener listener)
```
    Description copied from interface: IModule
    
    Listen for default output image.
    
    Specified by:
    
    setOutputListener in interface IModule
  - setOutputListener
```
public void setOutputListener(String name,
                              IOutputListener listener)
```
    Description copied from interface: IModule
    
    Listen for named output image.
    
    Specified by:
    
    setOutputListener in interface IModule
  - quit
```
public void quit()
```
    Description copied from interface: IWorkFlow
    
    Stops processing.
    
    Specified by:
    
    quit in interface IWorkFlow
  - clear
```
public void clear()
```
    Description copied from interface: IWorkFlow
    
    Clears wiring.
    
    Specified by:
    
    clear in interface IWorkFlow

Class WorkFlow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WORKFLOW

NAME

MODULES

MODULE

WIRES

WIRE

DST

SRC

INPUTS

INPUT

OUTPUTS

OUTPUT

Constructor Detail

WorkFlow

Method Detail

getName

setName

getLauncher

getInputNames

getOutputNames

fromXML

toXML

add

wire

wire

wire

wire

getWires

finalize

wireInput

wireInput

wireInput

wireInput

wireOutput

wireOutput

wireOutput

wireOutput

input

input

setOutputListener

setOutputListener

quit

clear