AbstractNode (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.lang.Thread
- - loci.multithreadedplugin.AbstractNode

All Implemented Interfaces:

Runnable, INode, IScheduledNode
```
public abstract class AbstractNode
extends Thread
implements INode
```
This abstract base class handles interaction with the NodeScheduler.

Author:

Aivar Grislis

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary
- Fields inherited from class java.lang.Thread
  MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
- Fields inherited from interface loci.multithreadedplugin.INode
  DEFAULT

Constructor Summary

Constructors
Constructor and Description

AbstractNode()

Constructors
Constructor and Description
`AbstractNode()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`associate(String outName, String fullName)` When chaining associates a named output with a named input tied to a particular instance of chained subclass.
`void`	`chainNext(IScheduledNode next)` Chains default output of this node to default input of next node.
`void`	`chainNext(IScheduledNode next, String inName)` Chains default output of this node to named input of next node.
`void`	`chainNext(String outName, IScheduledNode next)` Chains named output of this node to default input of next node.
`void`	`chainNext(String outName, IScheduledNode next, String inName)` Chains named output of this node to named input of next node.
`void`	`chainPrevious(IScheduledNode previous)` Chains default input of this node to default output of previous node.
`void`	`chainPrevious(IScheduledNode previous, String outName)` Chains default input of this node to named output of previous node.
`void`	`chainPrevious(String inName, IScheduledNode previous)` Chains named input of this node to default output of previous node.
`void`	`chainPrevious(String inName, IScheduledNode previous, String outName)` Chains named input of this node to named output of previous node.
`void`	`externalPut(Object object)` Feeds an image to the default input of the subclass.
`void`	`externalPut(String inName, Object object)` Feeds an image to a named input of the subclass.
`Object`	`get()` Gets the default input data from previous in chain.
`Object`	`get(String inName)` Gets a named input image from previous in chain.
`Set<String>`	`getInputNames()` Gets the set of annotated input names.
`Set<String>`	`getOutputNames()` Gets the set of annotated output names.
`abstract void`	`process()` This is the body of the plugin, defined in subclass.
`void`	`put(Object data)` Puts the default output data to next in chain (if any).
`void`	`put(String outName, Object data)` Puts named output data to next in chain (if any).
`void`	`quit()` Signals quitting time.
`void`	`run()` Loops until quitting time.
`String`	`uniqueInstance(String name)` Builds a name that is tied to this instance of the subclass.

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

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

- Constructor Detail
  - AbstractNode
```
public AbstractNode()
```
- Method Detail
  - uniqueInstance
```
public String uniqueInstance(String name)
```
    Builds a name that is tied to this instance of the subclass. Used to create a unique input name.
    
    Specified by:
    
    uniqueInstance in interface IScheduledNode
    
    Parameters:
    
    name - unqualified name
    
    Returns:
    
    qualified name
  - associate
```
public void associate(String outName,
                      String fullName)
```
    When chaining associates a named output with a named input tied to a particular instance of chained subclass.
    
    Specified by:
    
    associate in interface IScheduledNode
    
    Parameters:
    
    outName -
    
    fullName -
  - process
```
public abstract void process()
```
    This is the body of the plugin, defined in subclass.
  - get
```
public Object get()
```
    Gets the default input data from previous in chain. Called from subclass.
    
    Specified by:
    
    get in interface INode
    
    Returns:
    
    data
  - get
```
public Object get(String inName)
```
    Gets a named input image from previous in chain. Called from subclass.
    
    Specified by:
    
    get in interface INode
    
    Parameters:
    
    inName -
    
    Returns:
    
    image
  - put
```
public void put(Object data)
```
    Puts the default output data to next in chain (if any). Called from subclass.
    
    Specified by:
    
    put in interface INode
    
    Parameters:
    
    data -
  - put
```
public void put(String outName,
                Object data)
```
    Puts named output data to next in chain (if any). Called from subclass.
    
    Specified by:
    
    put in interface INode
    
    Parameters:
    
    outName -
    
    data -
  - chainNext
```
public void chainNext(IScheduledNode next)
```
    Chains default output of this node to default input of next node.
    
    Specified by:
    
    chainNext in interface INode
    
    Parameters:
    
    next - node
  - chainNext
```
public void chainNext(String outName,
                      IScheduledNode next)
```
    Chains named output of this node to default input of next node.
    
    Specified by:
    
    chainNext in interface INode
    
    Parameters:
    
    outName -
    
    next - node
  - chainNext
```
public void chainNext(IScheduledNode next,
                      String inName)
```
    Chains default output of this node to named input of next node.
    
    Specified by:
    
    chainNext in interface INode
    
    Parameters:
    
    next - node
    
    inName -
  - chainNext
```
public void chainNext(String outName,
                      IScheduledNode next,
                      String inName)
```
    Chains named output of this node to named input of next node.
    
    Specified by:
    
    chainNext in interface INode
    
    Parameters:
    
    outName -
    
    next - node
    
    inName -
  - chainPrevious
```
public void chainPrevious(IScheduledNode previous)
```
    Chains default input of this node to default output of previous node.
    
    Specified by:
    
    chainPrevious in interface INode
    
    Parameters:
    
    previous - node
  - chainPrevious
```
public void chainPrevious(String inName,
                          IScheduledNode previous)
```
    Chains named input of this node to default output of previous node.
    
    Specified by:
    
    chainPrevious in interface INode
    
    Parameters:
    
    inName -
    
    previous - node
  - chainPrevious
```
public void chainPrevious(IScheduledNode previous,
                          String outName)
```
    Chains default input of this node to named output of previous node.
    
    Specified by:
    
    chainPrevious in interface INode
    
    Parameters:
    
    previous - node
    
    outName -
  - chainPrevious
```
public void chainPrevious(String inName,
                          IScheduledNode previous,
                          String outName)
```
    Chains named input of this node to named output of previous node.
    
    Specified by:
    
    chainPrevious in interface INode
    
    Parameters:
    
    inName -
    
    previous - node
    
    outName -
  - run
```
public void run()
```
    Loops until quitting time.
    
    Specified by:
    
    run in interface Runnable
    
    Specified by:
    
    run in interface INode
    
    Overrides:
    
    run in class Thread
  - quit
```
public void quit()
```
    Signals quitting time.
    
    Specified by:
    
    quit in interface INode
  - externalPut
```
public void externalPut(Object object)
```
    Feeds an image to the default input of the subclass.
    
    Specified by:
    
    externalPut in interface INode
    
    Parameters:
    
    object -
  - externalPut
```
public void externalPut(String inName,
                        Object object)
```
    Feeds an image to a named input of the subclass.
    
    Specified by:
    
    externalPut in interface INode
    
    Parameters:
    
    inName -
    
    object -
  - getInputNames
```
public Set<String> getInputNames()
```
    Gets the set of annotated input names.
    
    Returns:
    
    set of names
  - getOutputNames
```
public Set<String> getOutputNames()
```
    Gets the set of annotated output names.
    
    Returns:
    
    set of names

Class AbstractNode

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Fields inherited from interface loci.multithreadedplugin.INode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Constructor Detail

AbstractNode

Method Detail

uniqueInstance

associate

process

get

get

put

put

chainNext

chainNext

chainNext

chainNext

chainPrevious

chainPrevious

chainPrevious

chainPrevious

run

quit

externalPut

externalPut

getInputNames

getOutputNames