org.trianacode.taskgraph.imp

Class NodeImp

java.lang.Object

org.trianacode.taskgraph.imp.NodeImp

All Implemented Interfaces:

NodeListener, Node

Direct Known Subclasses:

ParameterNodeImp, RunnableNode

public class NodeImp
extends java.lang.Object
implements NodeListener, Node

An input/output NodeCable associated with a Task.

Constructor Summary

Constructors

Constructor and Description
NodeImp(Task task, boolean input) Creates a node attached to the specified 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 a node is disposed
int	getAbsoluteNodeIndex() This is a convience method to provide backward compatibility with TrianaGUI, in which parameter nodes where indexed after data nodes.
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	nodeChildChanged(NodeEvent event) Called when one of a group node's child changes
void	nodeConnected(NodeEvent event) Called when a node is connected to a cable.
void	nodeDisconnected(NodeEvent event) Called before a node is diconnected from a cable.
void	nodeParentChanged(NodeEvent event) Called when one of a group node's parents changes
protected void	notifyChildNodeChanged() Notifies all the node listeners that a node in the child hierarchy has changed.
protected void	notifyNodeConnected() Notifies all the node listeners that the node has been connected.
protected void	notifyNodeDisconnected() Notifies all the node listeners that a the node has been disconnected.
protected void	notifyParameterNameSet() Notifies all the node listeners that the name of the parameter this node is inputting/outputting has been set.
protected void	notifyParentNodeChanged() Notifies all the node listeners that a node in the parent hierarchy has changed.
void	parameterNameSet(NodeEvent event) Called when the name of the parameter the node is inputting/outputting is set.
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
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NodeImp

public NodeImp(Task task,
       boolean input)

Creates a node attached to the specified Task.

Method Detail

getTask

public Task getTask()

Specified by:

getTask in interface Node

Returns:

the task this node is attached to

addNodeListener

public void addNodeListener(NodeListener listener)

Adds a node listener to this node.

Specified by:

addNodeListener in interface Node

removeNodeListener

public void removeNodeListener(NodeListener listener)

Removes a node listener from this node.

Specified by:

removeNodeListener in interface Node

getNodeIndex

public int getNodeIndex()

Specified by:

getNodeIndex in interface Node

Returns:

the index of this node within its associated task

getAbsoluteNodeIndex

public int getAbsoluteNodeIndex()

This is a convience method to provide backward compatibility with TrianaGUI, in which parameter nodes where indexed after data nodes.

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 node.

Specified by:

getAbsoluteNodeIndex in interface Node

Returns:

the absolute index of this node within its associated Task.

connect

public void connect(Cable cable)

Connect a cable to this node. Should only be called from within cable.

Specified by:

connect in interface Node

disconnect

public void disconnect()

Disconnect the cable from this node. Should only be called from within cable.

Specified by:

disconnect in interface Node

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Node

Returns:

true if this node is connected to a cable

getCable

public Cable getCable()

Specified by:

getCable in interface Node

Returns:

the cable this node is connected to

isInputNode

public boolean isInputNode()

Specified by:

isInputNode in interface Node

Returns:

true if this node is an input node

isOutputNode

public boolean isOutputNode()

Specified by:

isOutputNode in interface Node

Returns:

true if this node is an output node

isDataNode

public boolean isDataNode()

Specified by:

isDataNode in interface Node

Returns:

true if this node is a data node

isParameterNode

public boolean isParameterNode()

Specified by:

isParameterNode in interface Node

Returns:

true if this node is a parameter node

isOptional

public boolean isOptional()

Specified by:

isOptional in interface Node

Returns:

true if data is not required at this node for the task to run. Note that parameter nodes are optional by default.

isEssentialIfConnected

public boolean isEssentialIfConnected()

Specified by:

isEssentialIfConnected in interface Node

Returns:

true if data is essential at this node only if the node is connected

isEssential

public boolean isEssential()

Specified by:

isEssential in interface Node

Returns:

true if data is essential at this node for the task to run. Note that data nodes are essential by default.

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

Returns:

the parent group node for this node (null if top level)

setParentNode

public void setParentNode(Node node)

Sets the parent group node for this node

Specified by:

setParentNode in interface Node

getChildNode

public Node getChildNode()

Specified by:

getChildNode in interface Node

Returns:

the child group node for this node (null if bottom level)

setChildNode

public void setChildNode(Node node)

Sets the child group node for this node

Specified by:

setChildNode in interface Node

isTopLevelNode

public boolean isTopLevelNode()

Specified by:

isTopLevelNode in interface Node

Returns:

true if this is a top level group node (i.e. it is attached directly to an actual (non-group) task)

getTopLevelNode

public Node getTopLevelNode()

Specified by:

getTopLevelNode in interface Node

Returns:

the top level parent node in the parent/child group node hierarchy

getTopLevelTask

public Task getTopLevelTask()

Specified by:

getTopLevelTask in interface Node

Returns:

the top level parent task in the parent/child group task hierarchy

isBottomLevelNode

public boolean isBottomLevelNode()

Specified by:

isBottomLevelNode in interface Node

Returns:

true if this is a bottom level group node (i.e. it is attached directly to a actual cable task)

getBottomLevelNode

public Node getBottomLevelNode()

Specified by:

getBottomLevelNode in interface Node

Returns:

the bottom level parent node in the parent/child group node hierarchy

getBottomLevelTask

public Task getBottomLevelTask()

Specified by:

getBottomLevelTask in interface Node

Returns:

the bottom level parent task in the parent/child group task hierarchy

notifyNodeConnected

protected void notifyNodeConnected()

Notifies all the node listeners that the node has been connected.

notifyNodeDisconnected

protected void notifyNodeDisconnected()

Notifies all the node listeners that a the node has been disconnected.

notifyParameterNameSet

protected void notifyParameterNameSet()

Notifies all the node listeners that the name of the parameter this node is inputting/outputting has been set.

notifyParentNodeChanged

protected void notifyParentNodeChanged()

Notifies all the node listeners that a node in the parent hierarchy has changed.

notifyChildNodeChanged

protected void notifyChildNodeChanged()

Notifies all the node listeners that a node in the child hierarchy has changed.

nodeConnected

public void nodeConnected(NodeEvent event)

Called when a node is connected to a cable.

Specified by:

nodeConnected in interface NodeListener

nodeDisconnected

public void nodeDisconnected(NodeEvent event)

Called before a node is diconnected from a cable.

Specified by:

nodeDisconnected in interface NodeListener

nodeParentChanged

public void nodeParentChanged(NodeEvent event)

Called when one of a group node's parents changes

Specified by:

nodeParentChanged in interface NodeListener

nodeChildChanged

public void nodeChildChanged(NodeEvent event)

Called when one of a group node's child changes

Specified by:

nodeChildChanged in interface NodeListener

parameterNameSet

public void parameterNameSet(NodeEvent event)

Called when the name of the parameter the node is inputting/outputting is set.

Specified by:

parameterNameSet in interface NodeListener

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dispose

public void dispose()

Cleans-up when a node is disposed

Specified by:

dispose in interface Node

getName

public java.lang.String getName()

Specified by:

getName in interface Node