org.kepler.provenance

Class PortConnector<Id>

java.lang.Object

org.kepler.provenance.PortConnector<Id>

public class PortConnector<Id>
extends java.lang.Object

A utility class to map tokens from output to input ports.

Author:

Daniel Crawl

Constructor Summary

Constructors

Constructor and Description
PortConnector() Construct a new PortConnector.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all connections.
void	createConnections(IOPort port) Create connections for a port.
Id	getNextId(IOPort port, int channel) Get the next Id for an input port and channel.
void	receiveId(IOPort receiverPort, int channel, Id pass) A port should receive an id on a specific channel.
void	refillId(IOPort port, int channel) Restore the previous Id to a port and channel.
void	sendIdToConnections(IOPort senderPort, int channel, Id pass) Send an Id to an output port's connections on a channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortConnector

public PortConnector()

Construct a new PortConnector.

Method Detail

clear

public void clear()

Clear all connections.

createConnections

public void createConnections(IOPort port)
                       throws RecordingException

Create connections for a port.

Throws:

RecordingException

getNextId

public Id getNextId(IOPort port,
                    int channel)
             throws RecordingException

Get the next Id for an input port and channel.

Throws:

RecordingException

refillId

public void refillId(IOPort port,
                     int channel)
              throws RecordingException

Restore the previous Id to a port and channel.

Throws:

RecordingException

receiveId

public void receiveId(IOPort receiverPort,
                      int channel,
                      Id pass)
               throws RecordingException

A port should receive an id on a specific channel. This method should be used when a token is manually placed inside a receiver instead of when sent with one of the IOPort.send methods.

Throws:

RecordingException

sendIdToConnections

public void sendIdToConnections(IOPort senderPort,
                                int channel,
                                Id pass)
                         throws RecordingException

Send an Id to an output port's connections on a channel. NOTE: the receivers must be created in the actors, otherwise this method may fail to find connected ports.

Throws:

RecordingException