eu.mihosoft.vrl.workflow

Interface VFlow

public interface VFlow

The VFlow interface describes a workflow controller. A workflow is a network of VNodes. VNodes are connected using Connectors.

Author:

Michael Hoffer <info@michaelhoffer.de>

Property Summary

Type	Property and Description
ObjectProperty	model Returns the property of the model that is used by this flow controller.
ReadOnlyObjectProperty<VFlow>	parent

Method Summary

Modifier and Type	Method and Description
void	addConnections(Connections connections, String flowType) Adds the specified connections to this flow controller.
Connector	addInput(String type)
Connector	addOutput(String type)
void	addSkinFactories(Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> skinFactories) Adds the specified skin factories to this flow controller.
void	addSkinFactories(SkinFactory... skinFactories) Adds the specified skin factories to this flow controller.
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(VFlow s, VFlow r, String flowType)
ConnectionResult	connect(VFlow s, VNode r, String flowType)
ConnectionResult	connect(VNode s, VFlow r, String flowType)
ConnectionResult	connect(VNode s, VNode r, String flowType) Requests the specified connection.
ObservableMap<String,Connections>	getAllConnections() Returns all connections of this flow controller.
Connections	getConnections(String flowType) Returns the all connections of the specified flow/connection type
VFlow	getFlowById(String id) Returns child flow by id.
Class<? extends VNode>	getFlowNodeClass() Returns the flow node implementation class used by this flow controller.
IdGenerator	getIdGenerator() Returns the id generator used by this flow controller.
VFlowModel	getModel() Returns the model that is used by this flow controller.
NodeLookup	getNodeLookup() Returns the node lookup that is used by this flow controller.
ObservableList<VNode>	getNodes() Returns the nodes of this flow.
FlowNodeSkinLookup	getNodeSkinLookup()
List<VNodeSkin>	getNodeSkinsById(String id)
VFlow	getParent() Gets the value of the property parent.
VNode	getReceiver(Connection c) Returns the receiver of the specified connection.
VFlow	getRootFlow()
VNode	getSender(Connection c) Returns the sender of the specified connection.
Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>>	getSkinFactories() Returns the skin factories that are used by this flow controller.
Collection<VFlow>	getSubControllers() Returns all direct subcontrollers of this flow controller.
ObservableList<ThruConnector>	getThruInputs()
ObservableList<ThruConnector>	getThruOutputs()
boolean	isVisible()
ObjectProperty	modelProperty() Returns the property of the model that is used by this flow controller.
VNode	newNode() Adds a new node to this flow.
VNode	newNode(ValueObject obj) Adds a new node to this flow.
VFlow	newSubFlow() Adds a new subflow to this flow.
VFlow	newSubFlow(ValueObject obj) Adds a new subflow to this flow.
ReadOnlyObjectProperty<VFlow>	parentProperty()
VNode	remove(VNode n) Removes the specified node from this flow.
void	removeSkinFactories(Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> skinFactories) Removes the specified skin factories from this flow controller.
void	removeSkinFactories(SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>... skinFactories) Removes the specified skin factories from this flow controller.
void	setFlowNodeClass(Class<? extends VNode> cls) Defines the flow node implementation class used by this flow controller.
void	setIdGenerator(IdGenerator generator) Defines the id generator that shall be used by this flow controller.
void	setModel(VFlowModel flow) Defines the model that shall be used by this flow controller.
void	setNodeLookup(NodeLookup nodeLookup) Defines the node lookup that shall be used by this flow controller.
void	setNodeSkinLookup(FlowNodeSkinLookup skinLookup)
void	setSkinFactories(Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> skinFactories) Defines the skin factories for this flow controller.
void	setSkinFactories(SkinFactory... skinFactories) Defines the skin factories for this flow controller.
void	setVisible(boolean state)
ConnectionResult	tryConnect(Connector s, Connector r) Attempts to create the specified connection.
ConnectionResult	tryConnect(VFlow s, VFlow r, String flowType)
ConnectionResult	tryConnect(VFlow s, VNode r, String flowType)
ConnectionResult	tryConnect(VNode s, VFlow r, String flowType)
ConnectionResult	tryConnect(VNode s, VNode r, String flowType) Attempts to create the specified connection.
BooleanProperty	visibleState()

Property Detail

model

ObjectProperty modelProperty

Returns the property of the model that is used by this flow controller.

See Also:

getModel(), setModel(VFlowModel)

parent

ReadOnlyObjectProperty<VFlow> parentProperty

See Also:

getParent()

Method Detail

setModel

void setModel(VFlowModel flow)

Defines the model that shall be used by this flow controller.

Parameters:

flow - flow model

setNodeLookup

void setNodeLookup(NodeLookup nodeLookup)

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

Parameters:

nodeLookup -

getNodeLookup

NodeLookup getNodeLookup()

Returns the node lookup that is used by this flow controller.

Returns:

getModel

VFlowModel getModel()

Returns the model that is used by this flow controller.

Returns:

the model that is used by this flow controller

modelProperty

ObjectProperty modelProperty()

Returns the property of the model that is used by this flow controller.

See Also:

getModel(), setModel(VFlowModel)

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

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(VFlow s,
                            VNode r,
                            String flowType)

tryConnect

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

tryConnect

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

connect

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

connect

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

connect

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

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

getNodes

ObservableList<VNode> getNodes()

Returns the nodes of this flow.

Returns:

nodes of this flow

clear

void clear()

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

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 controller.

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 controller.

Returns:

all connections of this flow controller

setFlowNodeClass

void setFlowNodeClass(Class<? extends VNode> cls)

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

Parameters:

cls - flow node implementation class

getFlowNodeClass

Class<? extends VNode> getFlowNodeClass()

Returns the flow node implementation class used by this flow controller.

Returns:

the flow node implementation class used by this flow controller

newNode

VNode newNode(ValueObject obj)

Adds a new node to this flow.

Parameters:

obj - value object that shall be used for the requested node

Returns:

new node

newNode

VNode newNode()

Adds a new node to this flow.

Returns:

new node

newSubFlow

VFlow newSubFlow(ValueObject obj)

Adds a new subflow to this flow.

Parameters:

obj - value object that shall be used for the requested subflow

Returns:

new subflow

newSubFlow

VFlow newSubFlow()

Adds a new subflow to this flow.

Returns:

new subflow

getSubControllers

Collection<VFlow> getSubControllers()

Returns all direct subcontrollers of this flow controller. Subcontrollers of subcontrollers won't be returned. Use the getFlowById(java.lang.String) method to accomplish this.

Returns:

all direct subcontrollers of this flow controller

setSkinFactories

void setSkinFactories(SkinFactory... skinFactories)

Defines the skin factories for this flow controller.

Parameters:

skinFactories - skin factories that shall be used by this flow controller Doesn't use Generics because generic arrays are not supported. GENERICS ARE CRAPPY! http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6227971

setSkinFactories

void setSkinFactories(Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> skinFactories)

Defines the skin factories for this flow controller.

Parameters:

skinFactories - skin factories that shall be used by this flow controller

getSkinFactories

Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> getSkinFactories()

Returns the skin factories that are used by this flow controller.

Returns:

the skin factories that are used by this flow controller

addSkinFactories

void addSkinFactories(SkinFactory... skinFactories)

Adds the specified skin factories to this flow controller.

Parameters:

skinFactories - skin factories that shall be added to this flow controller Doesn't use Generics because generic arrays are not supported. GENERICS ARE CRAPPY! http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6227971

addSkinFactories

void addSkinFactories(Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> skinFactories)

Adds the specified skin factories to this flow controller.

Parameters:

skinFactories - skin factories that shall be added to this flow controller

removeSkinFactories

void removeSkinFactories(SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>... skinFactories)

Removes the specified skin factories from this flow controller.

Parameters:

skinFactories - skin factories to be removed

removeSkinFactories

void removeSkinFactories(Collection<SkinFactory<? extends ConnectionSkin,? extends VNodeSkin>> skinFactories)

Removes the specified skin factories from this flow controller.

Parameters:

skinFactories - skin factories to be removed

setIdGenerator

void setIdGenerator(IdGenerator generator)

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

Parameters:

generator - id generator

getIdGenerator

IdGenerator getIdGenerator()

Returns the id generator used by this flow controller.

Returns:

id generator

getNodeSkinsById

List<VNodeSkin> getNodeSkinsById(String id)

getNodeSkinLookup

FlowNodeSkinLookup getNodeSkinLookup()

setNodeSkinLookup

void setNodeSkinLookup(FlowNodeSkinLookup skinLookup)

setVisible

void setVisible(boolean state)

isVisible

boolean isVisible()

visibleState

BooleanProperty visibleState()

addInput

Connector addInput(String type)

addOutput

Connector addOutput(String type)

getFlowById

VFlow getFlowById(String id)

Returns child flow by id.

Parameters:

id - the id that specifies the requested flow

Returns:

the requested child flow or null if no such flow exists

getParent

VFlow getParent()

Gets the value of the property parent.

parentProperty

ReadOnlyObjectProperty<VFlow> parentProperty()

See Also:

getParent()

getRootFlow

VFlow getRootFlow()

addThruInput

ThruConnector addThruInput(String type)

addThruOutput

ThruConnector addThruOutput(String type)

getThruInputs

ObservableList<ThruConnector> getThruInputs()

getThruOutputs

ObservableList<ThruConnector> getThruOutputs()