Interface ICreateFlowGraphParams<TData, TElement extends IWorkflowNodeTypeProviding>

Type Parameters:
TData - Type of the properties model for the node. See INodeHandler.
TElement - Type of the processed node.
public interface ICreateFlowGraphParams<TData, TElement extends IWorkflowNodeTypeProviding>
Interface for the parameters that are passed to createFlowGraph of IWorkflowNodeFlowAnalyzer.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • controlTransferBackwardsEdge

      IFlowGraphEdgeDataConfigurator controlTransferBackwardsEdge()
      A configurator for marking an edge as a control transfer backwards edge. Intended for use with various connect methods from ICreateFlowGraphContext.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.controlTransferBackwardsEdge())
      Returns:
      A configurator for connecting nodes with throwing backwards edges.
      Since:
      8.0.0

    • controlTransferEdge

      IFlowGraphEdgeDataConfigurator controlTransferEdge()
      Retrieves a configurator for marking an edge as a control transfer forward (non-backwards) edge.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.controlTransferEdge())
      Returns:
      A configurator for connecting nodes with throwing edges.
      Since:
      8.0.0

    • getAnalysisContext

      ICreateFlowGraphContext<TElement> getAnalysisContext()
      Returns the context of the current analysis of potentially executed nodes. How children of a node are analyzed depends on the node kind - use createFlowGraph (or one of its variants) to start the analysis of child nodes.
      Returns:
      The context of the current execution analysis.

    • getChildren

      List<? extends TElement> getChildren()
      Returns:
      The children of the workflow node.

    • getData

      TData getData()
      Returns:
      The custom data of the given node.

    • getKey

      NodeKey getKey()
      Returns:
      The key of the workflow node.

    • getNode

      TElement getNode()
      The node that needs to be analyzed. The exact type of this element may be different depending on whether the execution analysis is run on the backend data model (WorkflowNode) or the corresponding frontend view model.
      Returns:
      The node to be analyzed.

    • newVirtualNode

      IVirtualFlowGraphNode newVirtualNode(EVirtualFlowGraphNodePurpose purpose)
      Creates a IVirtualFlowGraphNode and adds its to the flow graph.
      Parameters:
      purpose - The purpose of the virtual flow graph node.
      Returns:
      The newly creates virtual node.
      Since:
      8.1.0

    • normalBackwardsEdge

      IFlowGraphEdgeDataConfigurator normalBackwardsEdge()
      A configurator for marking an edge as a normal backwards edge. Intended for use with various connect methods from ICreateFlowGraphContext.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.normalBackwardsEdge())
      Returns:
      A configurator for connecting nodes with normal backwards edges.
      Since:
      8.0.0

    • normalEdge

      IFlowGraphEdgeDataConfigurator normalEdge()
      A configurator for marking an edge as a normal forward (non-backwards) edge. Intended for use with various connect methods from ICreateFlowGraphContext.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.normalEdge())}
      Returns:
      A configurator for connecting nodes with normal edges.
      Since:
      8.0.0

    • returningBackwardsEdge

      IFlowGraphEdgeDataConfigurator returningBackwardsEdge()
      A configurator for marking an edge as a returning backwards edge. Intended for use with various connect methods from ICreateFlowGraphContext.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.returningBackwardsEdge())
      Returns:
      A configurator for connecting nodes with throwing backwards edges.
      Since:
      8.0.0

    • returningEdge

      IFlowGraphEdgeDataConfigurator returningEdge()
      Retrieves a configurator for marking an edge as a returning forward (non-backwards) edge.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.returningEdge())
      Returns:
      A configurator for connecting nodes with throwing edges.
      Since:
      8.0.0

    • throwingBackwardsEdge

      IFlowGraphEdgeDataConfigurator throwingBackwardsEdge()
      A configurator for marking an edge as a throwing backwards edge. Intended for use with various connect methods from ICreateFlowGraphContext.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.throwingBackwardsEdge())
      Returns:
      A configurator for connecting nodes with throwing backwards edges.
      Since:
      8.0.0

    • throwingEdge

      IFlowGraphEdgeDataConfigurator throwingEdge()
      Retrieves a configurator for marking an edge as a throwing forward (non-backwards) edge.

      Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: 

      ctx.connect(from, to, params.throwingEdge())
      Returns:
      A configurator for connecting nodes with throwing edges.
      Since:
      8.0.0