Interface IFlowGraphEdgeData

All Superinterfaces:
Serializable
public interface IFlowGraphEdgeData extends Serializable
Data associated with an edge of a flow graph, see ITaskFlowAnalysis#getValueFlowGraph and INodeHandler#createFlowGraph.
Since:
8.0.0
Author:
XIMA MEDIA GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<NodeKey>
    getOwners()
    The nodes which own this edge, if any.
    long
    getType()
    The type of this edge, i.e. the circumstances when flow is transferred from the source to the target node.

  • Method Details

    • getType

      long getType()
      The type of this edge, i.e. the circumstances when flow is transferred from the source to the target node. See FlowGraphConnectionType for a list of types and their exact definition. The value returned by this method may be a bitwise-or combination of multiple flags from FlowGraphConnectionType.

      See FlowGraphConnectionType, which also includes several methods for querying the edge type.

      Returns:
      Bit flags with the type of this edge.
      See Also:

    • getOwners

      @Nonnull Set<NodeKey> getOwners()
      The nodes which own this edge, if any. The owner of an edge is the node which was responsible for adding the edge to the flow graph. For example: a sequence node adds edges between consecutive children; or a while-loop node adds an edge to the loop body, and an edge from the end of the loop boddy back to the beginning of the loop body.
      Returns:
      A set of all owners of this edge, never null but may be empty.