IWorkFlow (LOCI Javadocs 0-SNAPSHOT API)

All Superinterfaces:

IModule

All Known Implementing Classes:

WorkFlow
```
public interface IWorkFlow
extends IModule
```
An interface to build a workflow based on components that are chained together. The workflow itself is also a component. Building a workflow should take place in three phases: I. Add components II. Wire components together III. Wire workflow inputs and outputs -or- III. Finalize: leftover inputs and outputs become workflow inputs and outputs

Author:

Aivar Grislis

Method Summary

All Methods Instance Methods Abstract 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.
`Wire[]`	`getWires()` Gets the current chains.
`void`	`quit()` Stops processing.
`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 interface loci.deepzoom.workflow.IModule
getInputNames, getLauncher, getName, getOutputNames, input, input, setName, setOutputListener, setOutputListener

- Method Detail
  - add
```
void add(IModule component)
```
    Adds a component to the workflow in phase I.
    
    Parameters:
    
    component -
  - wire
```
void wire(IModule source,
          IModule dest)
```
    Chains default output of one component to default input of another. Phase II.
    
    Parameters:
    
    source -
    
    dest -
  - wire
```
void wire(IModule source,
          String sourceName,
          IModule dest)
```
    Chains named output of one component to default input of another. Phase II.
    
    Parameters:
    
    source -
    
    sourceName -
    
    dest -
  - wire
```
void wire(IModule source,
          IModule dest,
          String destName)
```
    Chains default output of one component to named input of another. Phase II.
    
    Parameters:
    
    source -
    
    dest -
    
    destName -
  - wire
```
void wire(IModule source,
          String sourceName,
          IModule dest,
          String destName)
```
    Chains named output of one component to named input of another. Phase II.
    
    Parameters:
    
    source -
    
    sourceName -
    
    dest -
    
    destName -
  - getWires
```
Wire[] getWires()
```
    Gets the current chains. Should be called after Phase II.
    
    Returns:
    
    array of chains
  - finalize
```
void finalize()
```
    Leftover, un-wired module inputs and outputs become workflow inputs and outputs. Phase II to III.
  - wireInput
```
void wireInput(IModule dest)
```
    Chains default workflow input to default input of component. Phase III.
    
    Parameters:
    
    dest -
  - wireInput
```
void wireInput(IModule dest,
               String destName)
```
    Chains default workflow input to named input of component. Phase III.
    
    Parameters:
    
    dest -
    
    destName -
  - wireInput
```
void wireInput(String inName,
               IModule dest)
```
    Chains named workflow input to default input of component. Phase III.
    
    Parameters:
    
    inName -
    
    dest -
  - wireInput
```
void wireInput(String inName,
               IModule dest,
               String destName)
```
    Chains named workflow input to named input of component. Phase III.
    
    Parameters:
    
    inName -
    
    dest -
    
    destName -
  - wireOutput
```
void wireOutput(IModule source)
```
    Chains default component output to default workflow output. Phase III.
    
    Parameters:
    
    source -
  - wireOutput
```
void wireOutput(IModule source,
                String sourceName)
```
    Chains named component output to default workflow output. Phase III.
    
    Parameters:
    
    source -
    
    sourceName -
  - wireOutput
```
void wireOutput(String outName,
                IModule source)
```
    Chains default component output to named workflow output. Phase III.
    
    Parameters:
    
    outName -
    
    source -
  - wireOutput
```
void wireOutput(String outName,
                IModule source,
                String sourceName)
```
    Chains named component output to named workflow output. Phase III.
    
    Parameters:
    
    outName -
    
    source -
    
    sourceName -
  - toXML
```
String toXML()
```
    Saves chained components as XML string representation. Only after Phase III is complete.
    
    Specified by:
    
    toXML in interface IModule
    
    Returns:
  - fromXML
```
boolean fromXML(String xml)
```
    Restores chained components from XML string representation. Accomplishes Phases I-III.
    
    Specified by:
    
    fromXML in interface IModule
    
    Parameters:
    
    xml -
    
    Returns:
    
    whether successfully parsed
  - quit
```
void quit()
```
    Stops processing.
  - clear
```
void clear()
```
    Clears wiring.

Interface IWorkFlow

Method Summary

Methods inherited from interface loci.deepzoom.workflow.IModule

Method Detail

add

wire

wire

wire

wire

getWires

finalize

wireInput

wireInput

wireInput

wireInput

wireOutput

wireOutput

wireOutput

wireOutput

toXML

fromXML

quit

clear