eu.mihosoft.vrl.workflow

Interface Connections

All Superinterfaces:

Model

public interface Connections
extends Model

This interface defines a collection of Connection

Author:

Michael Hoffer <info@michaelhoffer.de>

Property Summary

Properties inherited from interface eu.mihosoft.vrl.workflow.Model

visualizationRequest

Method Summary

Modifier and Type	Method and Description
void	add(Connection c) Adds a connection to this collection.
Connection	add(Connector s, Connector r) Adds the connection defined by the specified connectors.
Connection	add(String id, Connector s, Connector r, VisualizationRequest vReq) Adds the connection defined by the specified connectors.
boolean	contains(Connector s, Connector r) Determines if a connection exists between the specified connectors.
Connection	get(String id, Connector s, Connector r) Returns the specified connection.
Collection<Connection>	getAll(Connector s, Connector r) Returns all connections betwenn the specified connectors.
Collection<Connection>	getAllWith(Connector c) Returns all connections that are connected to the specified connector.
Collection<Connection>	getAllWithNode(VNode n) Returns all connections that are connected to the specified node.
Class<? extends Connection>	getConnectionClass() Returns the connection implementation class.
ObservableList<Connection>	getConnections() Returns the connections defined by this collection.
String	getType() Returns the connection type of this collection.
boolean	isInputConnected(Connector id) Determines whether the specified input connector is connected.
boolean	isOutputConnected(Connector id) Determines whether the specified output connector is connected.
void	remove(Connection c) Removes the specified connection from this collection
void	remove(String id, Connector s, Connector r) Removes the specified connection from this collection.
void	removeAll(Connector s, Connector r) Removes all connections between the specified connectors from this collection.
void	setConnectionClass(Class<? extends Connection> cls) Defines the connection implementation class that shall be used.

Methods inherited from interface eu.mihosoft.vrl.workflow.Model

getVisualizationRequest, isVisualizationRequestInitialized, setVisualizationRequest, visualizationRequestProperty

Method Detail

add

void add(Connection c)

Adds a connection to this collection.

Parameters:

c - the connection to add

add

Connection add(Connector s,
               Connector r)

Adds the connection defined by the specified connectors.

Parameters:

s - sender connector

r - receiver connector

Returns:

connection that has been added

add

Connection add(String id,
               Connector s,
               Connector r,
               VisualizationRequest vReq)

Adds the connection defined by the specified connectors.

Parameters:

id - the id of the connection that shall be added

s - the sender connector

r - the receiver connector

vReq - the visualization request of the connection

Returns:

connection that has been added

remove

void remove(Connection c)

Removes the specified connection from this collection

Parameters:

c - connection to remove

get

Connection get(String id,
               Connector s,
               Connector r)

Returns the specified connection.

Parameters:

id - id of the connection to be returned

s - sender connector

r - receiver connector

Returns:

the requested connection or null if no such connection exists

getAll

Collection<Connection> getAll(Connector s,
                              Connector r)

Returns all connections betwenn the specified connectors.

Parameters:

s - sender connector

r - receiver connector

Returns:

all connections betwenn the specified connectors

remove

void remove(String id,
            Connector s,
            Connector r)

Removes the specified connection from this collection.

Parameters:

id - connection id

s - sender connector

r - receiver connector

removeAll

void removeAll(Connector s,
               Connector r)

Removes all connections between the specified connectors from this collection.

Parameters:

s - sender connector

r - receiver connector

setConnectionClass

void setConnectionClass(Class<? extends Connection> cls)

Defines the connection implementation class that shall be used.

Parameters:

cls - connection implementation class

getConnectionClass

Class<? extends Connection> getConnectionClass()

Returns the connection implementation class.

Returns:

the connection implementation class

getConnections

ObservableList<Connection> getConnections()

Returns the connections defined by this collection.

Returns:

the connections defined by this collection

getAllWith

Collection<Connection> getAllWith(Connector c)

Returns all connections that are connected to the specified connector.

Parameters:

c - connector

Returns:

all connections that are connected to the specified connector

getAllWithNode

Collection<Connection> getAllWithNode(VNode n)

Returns all connections that are connected to the specified node.

Parameters:

n - node

Returns:

all connections that are connected to the specified node

isInputConnected

boolean isInputConnected(Connector id)

Determines whether the specified input connector is connected.

Parameters:

id - connector id

Returns:

true if the specified input connector is connected; false otherwise

isOutputConnected

boolean isOutputConnected(Connector id)

Determines whether the specified output connector is connected.

Parameters:

id - connector id

Returns:

true if the specified output connector is connected; false otherwise

contains

boolean contains(Connector s,
                 Connector r)

Determines if a connection exists between the specified connectors.

Parameters:

s - sender connector

r - receiver connector

Returns:

true if a connection between the specified connectors exists; false otherwise

getType

String getType()

Returns the connection type of this collection.

Returns:

connection type (e.g. "control" or "data")