eu.mihosoft.vrl.workflow

Class FlowModelImpl

java.lang.Object

eu.mihosoft.vrl.workflow.FlowModelImpl

public class FlowModelImpl
extends Object

This class implements the flow model. The flow model manages the connections between nodes.

Author:

Michael Hoffer <info@michaelhoffer.de>

Property Summary

Type	Property and Description
BooleanProperty	visible
ReadOnlyProperty<VisualizationRequest>	visualizationRequest Returns the visualization request property of this model.

Constructor Summary

Constructors

Constructor and Description
FlowModelImpl()

Method Summary

Modifier and Type	Method and Description
void	addConnections(Connections connections, String flowType) Adds the specified connections to this flow.
void	clear() Clears this flow, i.e., removes all nodes and connections.
ConnectionResult	connect(Connector s, Connector r) Requests the specified connection.
ConnectionResult	connect(VNode s, VNode r, String type) Requests the specified connection.
ObservableMap<String,Connections>	getAllConnections() Returns all connections of this flow.
Connections	getConnections(String type) Returns the all connections of the specified flow/connection type
Class<? extends VNode>	getFlowNodeClass() Returns the flow node implementation class used by this flow.
IdGenerator	getIdGenerator() Returns the id generator used by this flow.
NodeLookup	getNodeLookup() Returns the node lookup that is used by this flow.
ObservableList<VNode>	getNodes() Returns the nodes of this flow.
VNode	getReceiver(Connection c) Returns the receiver of the specified connection.
VNode	getSender(Connection c) Returns the sender of the specified connection.
VisualizationRequest	getVisualizationRequest() Gets the value of the property visualizationRequest.
boolean	isVisible() Gets the value of the property visible.
boolean	isVisualizationRequestInitialized() Determines whether the visualization request is already initialized.
VNode	remove(VNode n) Removes the specified node from this flow.
void	setFlowNodeClass(Class<? extends VNode> cls) Defines the flow node implementation class used by this flow model.
void	setIdGenerator(IdGenerator idGenerator) Defines the id generator that shall be used by this flow.
void	setNodeLookup(NodeLookup nodeLookup) Defines the node lookup that shall be used by this flow.
void	setVisible(boolean b) Sets the value of the property visible.
void	setVisualizationRequest(VisualizationRequest vReq) Sets the value of the property visualizationRequest.
ConnectionResult	tryConnect(Connector s, Connector r) Attempts to create the specified connection.
ConnectionResult	tryConnect(VNode s, VNode r, String type) Attempts to create the specified connection.
BooleanProperty	visibleProperty()
ReadOnlyProperty<VisualizationRequest>	visualizationRequestProperty() Returns the visualization request property of this model.

Methods inherited from class java.lang.Object

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

Property Detail

visible

public BooleanProperty visibleProperty

See Also:

isVisible(), setVisible(boolean)

visualizationRequest

public ReadOnlyProperty<VisualizationRequest> visualizationRequestProperty

Returns:

visualization request property

See Also:

getVisualizationRequest(), setVisualizationRequest(VisualizationRequest)

Constructor Detail

FlowModelImpl

public FlowModelImpl()

Method Detail

visibleProperty

public BooleanProperty visibleProperty()

See Also:

isVisible(), setVisible(boolean)

setVisible

public void setVisible(boolean b)

Sets the value of the property visible.

isVisible

public boolean isVisible()

Gets the value of the property visible.

tryConnect

public ConnectionResult tryConnect(VNode s,
                                   VNode r,
                                   String type)

Attempts to create the specified connection. This method never creates an actual connection. It only checks whether the requested connection is valid.

Parameters:

s - sender node (uses main output connector of this node if specified)

r - receiver node (uses main input connector of this node if specified)

type - connection type

Returns:

connection result

connect

public ConnectionResult connect(VNode s,
                                VNode r,
                                String type)

Requests the specified connection. If the specified connection can be established it will be created.

Parameters:

s - sender node

r - receiver node

type - connection type

Returns:

connection result

tryConnect

public ConnectionResult tryConnect(Connector s,
                                   Connector r)

Attempts to create the specified connection. This method never creates an actual connection. It only checks whether the requested connection is valid.

Parameters:

s - sender connector

r - receiver connector

Returns:

connection result

connect

public ConnectionResult connect(Connector s,
                                Connector r)

Requests the specified connection. If the specified connection can be established it will be created.

Parameters:

s - sender node

r - receiver node

Returns:

connection result

getNodes

public ObservableList<VNode> getNodes()

Returns the nodes of this flow.

Returns:

nodes of this flow

clear

public void clear()

Clears this flow, i.e., removes all nodes and connections.

remove

public VNode remove(VNode n)

Removes the specified node from this flow.

Parameters:

n - the node to remove

Returns:

the removed node or null if no node has been removed

getAllConnections

public ObservableMap<String,Connections> getAllConnections()

Returns all connections of this flow.

Returns:

all connections of this flow

getConnections

public Connections getConnections(String type)

Returns the all connections of the specified flow/connection type

Parameters:

type - connection type

Returns:

all connections of the specified flow/connection type

getSender

public VNode getSender(Connection c)

Returns the sender of the specified connection.

Parameters:

c - connection

Returns:

the sender of the specified connection or null if the node does not exist

getReceiver

public VNode getReceiver(Connection c)

Returns the receiver of the specified connection.

Parameters:

c - connection

Returns:

the receiver of the specified connection or null if the node does not exist

setFlowNodeClass

public void setFlowNodeClass(Class<? extends VNode> cls)

Defines the flow node implementation class used by this flow model.

Parameters:

cls - flow node implementation class

getFlowNodeClass

public Class<? extends VNode> getFlowNodeClass()

Returns the flow node implementation class used by this flow.

Returns:

the flow node implementation class used by this flow

addConnections

public void addConnections(Connections connections,
                           String flowType)

Adds the specified connections to this flow.

Parameters:

connections - connections to add

flowType - connection type

getVisualizationRequest

public VisualizationRequest getVisualizationRequest()

Gets the value of the property visualizationRequest.

Returns:

visualization request or null if no visualization request exists

setVisualizationRequest

public void setVisualizationRequest(VisualizationRequest vReq)

Sets the value of the property visualizationRequest.

Parameters:

vReq - visualization request

getIdGenerator

public IdGenerator getIdGenerator()

Returns the id generator used by this flow.

Returns:

the idGenerator

setIdGenerator

public void setIdGenerator(IdGenerator idGenerator)

Defines the id generator that shall be used by this flow.

Parameters:

idGenerator - the idGenerator to set

getNodeLookup

public NodeLookup getNodeLookup()

Returns the node lookup that is used by this flow.

Returns:

the nodeLookup

setNodeLookup

public void setNodeLookup(NodeLookup nodeLookup)

Defines the node lookup that shall be used by this flow.

Parameters:

nodeLookup - the nodeLookup to set

visualizationRequestProperty

public ReadOnlyProperty<VisualizationRequest> visualizationRequestProperty()

Description copied from interface: Model

Returns the visualization request property of this model.

Returns:

visualization request property

See Also:

getVisualizationRequest(), setVisualizationRequest(VisualizationRequest)

isVisualizationRequestInitialized

public boolean isVisualizationRequestInitialized()

Description copied from interface: Model

Determines whether the visualization request is already initialized. Use this method to prevent unnecessary initialization. Depending on the model implementation Model.getVisualizationRequest() can cause initialization.

Returns:

true if the visualization request is already initialized