org.trianacode.taskgraph.imp

Class CableImp

java.lang.Object

org.trianacode.taskgraph.imp.CableImp

All Implemented Interfaces:

Cable

Direct Known Subclasses:

LocalCable, QueueCable

public class CableImp
extends java.lang.Object
implements Cable

A cable linking two Tasks in a TaskGraphImp. The Tasks are linked through their input/output Nodes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NON_RUNNABLE_CABLE

Fields inherited from interface org.trianacode.taskgraph.Cable

CONTROL_CABLE_TYPE

Constructor Summary

Constructors

Constructor and Description
CableImp()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCableListener(CableListener listener) Adds a cable listener to this cable.
void	connect(Node sendnode, Node recnode) Connect two nodes with this cable.
boolean	connects(Task task)
boolean	contains(Node node)
void	disconnect() Disconnect this cable from its nodes.
Node	getReceivingNode()
Task	getReceivingTask()
Node	getSendingNode()
Task	getSendingTask()
java.lang.String	getType()
boolean	isConnected()
void	reconnect(Node node) Reconnects the sender to this cable
void	removeCableListener(CableListener listener) Removes a cable listener from this cable.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NON_RUNNABLE_CABLE

public static final java.lang.String NON_RUNNABLE_CABLE

See Also:

Constant Field Values

Constructor Detail

CableImp

public CableImp()

Method Detail

getType

public java.lang.String getType()

Specified by:

getType in interface Cable

Returns:

the type of the cable

connect

public void connect(Node sendnode,
           Node recnode)
             throws CableException

Connect two nodes with this cable.

Specified by:

connect in interface Cable

Throws:

CableException

reconnect

public void reconnect(Node node)
               throws CableException

Reconnects the sender to this cable

Specified by:

reconnect in interface Cable

Throws:

CableException

disconnect

public void disconnect()
                throws CableException

Disconnect this cable from its nodes. Note that a disconnected cable cannot be reconnected.

Specified by:

disconnect in interface Cable

Throws:

CableException

addCableListener

public void addCableListener(CableListener listener)

Adds a cable listener to this cable.

Specified by:

addCableListener in interface Cable

removeCableListener

public void removeCableListener(CableListener listener)

Removes a cable listener from this cable.

Specified by:

removeCableListener in interface Cable

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Cable

Returns:

true if this cable is connected.

getSendingNode

public Node getSendingNode()

Specified by:

getSendingNode in interface Cable

Returns:

the node which sends data along this cable

getSendingTask

public Task getSendingTask()

Specified by:

getSendingTask in interface Cable

Returns:

the task which sends data (via a node) along this cable

getReceivingNode

public Node getReceivingNode()

Specified by:

getReceivingNode in interface Cable

Returns:

the node which receives data along this cable

getReceivingTask

public Task getReceivingTask()

Specified by:

getReceivingTask in interface Cable

Returns:

the task which receives data (via a node) along this cable

contains

public boolean contains(Node node)

Specified by:

contains in interface Cable

Returns:

true if the specified node sends data to or receives data from this cable

connects

public boolean connects(Task task)

Specified by:

connects in interface Cable

Returns:

true if the specified task sends data to or receives data from this cable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object