FAQ

What is the difference between VWorkflows-core and -fx?

VWorkflows-Core provides a flow/graph model with multiple edge types and an abstract skin model that does not depend on a specific ui technology. Skins are created by factories that can be nested. They define hierarchical relations which allows for easy subflow visualization.

VWorkflows-FX is a JavaFX based UI for the core model. It utilizes components from the JFXtras project (Window control, ScalableContentPane). It supports

• subflow visualization
• arbitrary zoom levels
• multiple visualizations of the same flow (visualizations are synced and fully editable)
• zoom dependent visualization (level of detail)
• ...

How can I create a simple workflow?

// create a flow object
VFlow flow = FlowFactory.newFlow();

// add two nodes to the flow
VNode n1 = flow.newNode();
VNode n2 = flow.newNode();

// create input and output connectors of type "default-type"
Connector inN1 = n1.addInput("default-type");
Connector outN1 = n1.addOutput("default-type");
Connector inN2 = n2.addInput("default-type");
Connector outN2 = n2.addOutput("default-type");

// create a connections
flow.connect(outN1, inN2);

How to visualize flows with JavaFX?

// we assume a flow already exists
VFlow flow = ...
// make the flow visible
flow.setVisible(true);

// create a zoomable canvas
VCanvas canvas = new VCanvas();
Pane root = canvas.getContentPane();

// creating a skin factory and attach it to the flow
FXSkinFactory skinFactory = new FXSkinFactory(rootPane);
flow.setSkinFactories(skinFactory);

How to create subflows?

// create a flow object
VFlow flow = FlowFactory.newFlow();

// create a subflow
VFlow subFlow = flow.newSubFlow();

How can I save flows?

WorkflowIO.saveToXML(Paths.get("flow-01.xml"), flow1.getModel());

How can I load flows?

VFlow flow = WorkflowIO.loadFromXML(Paths.get("flow-01.xml"));

How can I check whether connectors are compatible?

// we assume a flow already exists
VFlow flow = ...

// we assume that connector c1 and c2 exit
Connector c1 = ...
Connector c2 = ...

// check compatibility
ConnectionResult result = flow.tryConnect(c1,c2);

if (!result.getStatus().isCompatible()) {
    // connection failed!
    // use message string to create report status
    String msg = result.getStatus().getMessage();
}