eu.mihosoft.vrl.workflow

Interface VFlowModel

All Superinterfaces:

Model, Selectable, VNode

public interface VFlowModel
extends VNode

Author:

Michael Hoffer <info@michaelhoffer.de>

Property Summary

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

visible

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

height, id, selectable, title, valueObject, width, x, y

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

visualizationRequest

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

selected

Method Summary

Modifier and Type	Method and Description
void	addConnections(Connections connections, String flowType) Adds the specified connections to this flow.
ThruConnector	addThruInput(String type)
ThruConnector	addThruOutput(String type)
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 flowType) Requests the specified connection.
ObservableMap<String,Connections>	getAllConnections() Returns all connections of this flow.
Connections	getConnections(String flowType) 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.
ObservableList<ThruConnector>	getThruInputs()
ObservableList<ThruConnector>	getThruOutputs()
VFlowModel	newFlowNode()
VFlowModel	newFlowNode(ValueObject obj)
VNode	newNode()
VNode	newNode(ValueObject obj)
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 generator) 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.
ConnectionResult	tryConnect(Connector s, Connector r) Attempts to create the specified connection.
ConnectionResult	tryConnect(VNode s, VNode r, String flowType) Attempts to create the specified connection.

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

isVisible, setVisible, visibleProperty

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

addConnector, addInput, addOutput, getConnector, getConnectors, getDepth, getFlow, getHeight, getId, getInputs, getMainInput, getMainInputTypes, getMainOutput, getMainOutputTypes, getOutputs, getRoot, getTitle, getValueObject, getWidth, getX, getY, heightProperty, idProperty, isSelectable, removeConnector, selectableProperty, setHeight, setId, setMainInput, setMainOutput, setTitle, setValueObject, setWidth, setX, setY, titleProperty, valueObjectProperty, widthProperty, xProperty, yProperty

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

getVisualizationRequest, isVisualizationRequestInitialized, setVisualizationRequest, visualizationRequestProperty

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

isSelected, requestSelection, selectedProperty

Method Detail

newFlowNode

VFlowModel newFlowNode(ValueObject obj)

newFlowNode

VFlowModel newFlowNode()

newNode

VNode newNode(ValueObject obj)

newNode

VNode newNode()

addThruInput

ThruConnector addThruInput(String type)

addThruOutput

ThruConnector addThruOutput(String type)

getThruInputs

ObservableList<ThruConnector> getThruInputs()

getThruOutputs

ObservableList<ThruConnector> getThruOutputs()

tryConnect

ConnectionResult tryConnect(VNode s,
                            VNode r,
                            String flowType)

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)

flowType - connection type

Returns:

connection result

connect

ConnectionResult connect(VNode s,
                         VNode r,
                         String flowType)

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

Parameters:

s - sender node

r - receiver node

flowType - connection type

Returns:

connection result

tryConnect

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

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

remove

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

clear

void clear()

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

getNodes

ObservableList<VNode> getNodes()

Returns the nodes of this flow.

Returns:

nodes of this flow

getSender

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

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

addConnections

void addConnections(Connections connections,
                    String flowType)

Adds the specified connections to this flow.

Parameters:

connections - connections to add

flowType - connection type

getConnections

Connections getConnections(String flowType)

Returns the all connections of the specified flow/connection type

Parameters:

flowType - connection type

Returns:

all connections of the specified flow/connection type

getAllConnections

ObservableMap<String,Connections> getAllConnections()

Returns all connections of this flow.

Returns:

all connections of this flow

setFlowNodeClass

void setFlowNodeClass(Class<? extends VNode> cls)

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

Parameters:

cls - flow node implementation class

getFlowNodeClass

Class<? extends VNode> getFlowNodeClass()

Returns the flow node implementation class used by this flow.

Returns:

the flow node implementation class used by this flow

setIdGenerator

void setIdGenerator(IdGenerator generator)

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

Parameters:

generator - id generator

getIdGenerator

IdGenerator getIdGenerator()

Returns the id generator used by this flow.

Returns:

id generator

setNodeLookup

void setNodeLookup(NodeLookup nodeLookup)

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

Parameters:

nodeLookup - node lookup

getNodeLookup

NodeLookup getNodeLookup()

Returns the node lookup that is used by this flow.

Returns:

node lookup