Node

All Known Subinterfaces:

ParameterNode, RunnableNodeInterface

All Known Implementing Classes:

ErrorNode, NodeImp, ParameterNodeImp, RunnableNode, RunnableParameterNode, TriggerNode
```
public interface Node
```
An interface for accessing the NodeCable associated with a Task.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addNodeListener(NodeListener listener)` Adds a node listener to this node.
`void`	`connect(Cable cable)` Connect a cable to this node.
`void`	`disconnect()` Disconnect the cable from this node.
`void`	`dispose()` Cleans-up when the node is no longer used
`int`	`getAbsoluteNodeIndex()` This is a convience method to return the absolute positioning of a node.
`Node`	`getBottomLevelNode()`
`Task`	`getBottomLevelTask()`
`Cable`	`getCable()`
`Node`	`getChildNode()`
`java.lang.String`	`getName()`
`int`	`getNodeIndex()`
`Node`	`getParentNode()`
`Task`	`getTask()`
`Node`	`getTopLevelNode()`
`Task`	`getTopLevelTask()`
`boolean`	`isBottomLevelNode()`
`boolean`	`isConnected()`
`boolean`	`isDataNode()`
`boolean`	`isEssential()`
`boolean`	`isEssentialIfConnected()`
`boolean`	`isInputNode()`
`boolean`	`isOptional()`
`boolean`	`isOutputNode()`
`boolean`	`isParameterNode()`
`boolean`	`isTopLevelNode()`
`void`	`removeNodeListener(NodeListener listener)` Removes a node listener from this node.
`void`	`setChildNode(Node node)` Sets the child group node for this node
`void`	`setParentNode(Node node)` Sets the parent group node for this node

- Method Detail
  - getTask
```
Task getTask()
```
    Returns:
    the task this node is attached to
  - addNodeListener
```
void addNodeListener(NodeListener listener)
```
    Adds a node listener to this node.
  - removeNodeListener
```
void removeNodeListener(NodeListener listener)
```
    Removes a node listener from this node.
  - getNodeIndex
```
int getNodeIndex()
```
    Returns:
    the index of this node within its associated task (or -1 if disposed/not attached to a task)
  - getAbsoluteNodeIndex
```
int getAbsoluteNodeIndex()
```
    This is a convience method to return the absolute positioning of a node.
    The absolute index of a data node is the same as its standard index. The absolute index of a parameter node is its standard index + the total number of data input/output nodes.
    
    Returns:
    the absolute index of this node within its associated task (or -1 if disposed/not attached to a task)
  - isConnected
```
boolean isConnected()
```
    Returns:
    true if this node is connected to a cable
  - getCable
```
Cable getCable()
```
    Returns:
    the cable this node is connected to
  - isInputNode
```
boolean isInputNode()
```
    Returns:
    true if this node is an input node
  - isOutputNode
```
boolean isOutputNode()
```
    Returns:
    true if this node is an output node
  - isDataNode
```
boolean isDataNode()
```
    Returns:
    true if this node is a data node
  - isParameterNode
```
boolean isParameterNode()
```
    Returns:
    true if this node is a parameter node
  - isOptional
```
boolean isOptional()
```
    Returns:
    true if data is not required at this node for the task to run
  - isEssential
```
boolean isEssential()
```
    Returns:
    true if data is essential at this node for the task to run
  - isEssentialIfConnected
```
boolean isEssentialIfConnected()
```
    Returns:
    true if data is essential at this node only if the node is connected
  - isTopLevelNode
```
boolean isTopLevelNode()
```
    Returns:
    true if this is a top level group node (i.e. it is attached directly to an actual (non-group) task)
  - getTopLevelNode
```
Node getTopLevelNode()
```
    Returns:
    the top level parent node in the parent/child group node hierarchy
  - getTopLevelTask
```
Task getTopLevelTask()
```
    Returns:
    the top level parent task in the parent/child group task hierarchy
  - isBottomLevelNode
```
boolean isBottomLevelNode()
```
    Returns:
    true if this is a bottom level group node (i.e. it is attached directly to a actual cable)
  - getBottomLevelNode
```
Node getBottomLevelNode()
```
    Returns:
    the bottom level parent node in the parent/child group node hierarchy
  - getBottomLevelTask
```
Task getBottomLevelTask()
```
    Returns:
    the bottom level parent task in the parent/child group task hierarchy
  - getParentNode
```
Node getParentNode()
```
    Returns:
    the parent group node for this node (null if top level)
  - getChildNode
```
Node getChildNode()
```
    Returns:
    the child group node for this node (null if bottom level)
  - connect
```
void connect(Cable cable)
```
    Connect a cable to this node. Should only be called from within cable.
  - disconnect
```
void disconnect()
```
    Disconnect the cable from this node. Should only be called from within cable.
  - setParentNode
```
void setParentNode(Node node)
```
    Sets the parent group node for this node
  - setChildNode
```
void setChildNode(Node node)
```
    Sets the child group node for this node
  - dispose
```
void dispose()
```
    Cleans-up when the node is no longer used
  - getName
```
java.lang.String getName()
```

Interface Node

Method Summary

Method Detail

getTask

addNodeListener

removeNodeListener

getNodeIndex

getAbsoluteNodeIndex

isConnected

getCable

isInputNode

isOutputNode

isDataNode

isParameterNode

isOptional

isEssential

isEssentialIfConnected

isTopLevelNode

getTopLevelNode

getTopLevelTask

isBottomLevelNode

getBottomLevelNode

getBottomLevelTask

getParentNode

getChildNode

connect

disconnect

setParentNode

setChildNode

dispose

getName