Interface IWorkflowFlowAnalysis
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
WorkflowFlowAnalysis
public interface IWorkflowFlowAnalysis extends Serializable
Interface for querying info about the control and data flow of a workflow process. Instances should usually only represent the result of the analysis, the actual computation should be done before the instance is created (or during the constructor call).- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Set<NodeKey>
getPotentialPredecessorsOf(NodeKey targetKey)
default Set<NodeKey>
getPotentialPredecessorsOf(NodeKey targetKey, FlowGraphFilter.Backward filter)
default Set<NodeKey>
getPotentialSuccessorsOf(NodeKey sourceKey)
Deprecated.default Set<NodeKey>
getPotentialSuccessorsOf(NodeKey sourceKey, FlowGraphFilter.Forward filter)
ITaskFlowAnalysis
getTaskAnalysis(UUID taskUuid)
default boolean
isNodePotentiallyReachable(NodeKey sourceKey, NodeKey targetKey)
default boolean
isNodePotentiallyReachable(NodeKey sourceKey, NodeKey targetKey, FlowGraphFilter.Generic filter)
-
-
-
Method Detail
-
getPotentialPredecessorsOf
@Deprecated default Set<NodeKey> getPotentialPredecessorsOf(NodeKey targetKey)
- Parameters:
targetKey
- The key of the target node to check.- Returns:
- The keys of all nodes for which
isNodePotentiallyReachable(nodeUuid, targetUuid)
returnstrue
. - See Also:
ITaskFlowAnalysis.getPotentialPredecessorsOf(NodeKey)
-
getPotentialPredecessorsOf
default Set<NodeKey> getPotentialPredecessorsOf(NodeKey targetKey, FlowGraphFilter.Backward filter)
- Parameters:
targetKey
- The key of the target node to check.filter
- Filter applied when traversing the flow graph for finding paths from the target to preceeding edges. SeeFlowGraphFilters
for some common filters.- Returns:
- The keys of all nodes for which
isNodePotentiallyReachable(nodeUuid, targetUuid)
returnstrue
. - Since:
- 8.0.0
- See Also:
ITaskFlowAnalysis.getPotentialPredecessorsOf(NodeKey)
-
getPotentialSuccessorsOf
@Deprecated default Set<NodeKey> getPotentialSuccessorsOf(NodeKey sourceKey)
Deprecated.- Parameters:
sourceKey
- The key of the target node to check.- Returns:
- The keys of all nodes for which
isNodePotentiallyReachable(sourceUuid, nodeUuid)
returnstrue
. - See Also:
ITaskFlowAnalysis.getPotentialSuccessorsOf(NodeKey)
-
getPotentialSuccessorsOf
default Set<NodeKey> getPotentialSuccessorsOf(NodeKey sourceKey, FlowGraphFilter.Forward filter)
- Parameters:
sourceKey
- The key of the target node to check.filter
- Filter applied when traversing the flow graph for finding paths from the source to succeeding edges. SeeFlowGraphFilters
for some common filters.- Returns:
- The keys of all nodes for which
isNodePotentiallyReachable(sourceUuid, nodeUuid)
returnstrue
. - Since:
- 8.0.0
- See Also:
ITaskFlowAnalysis.getPotentialSuccessorsOf(NodeKey)
-
getTaskAnalysis
ITaskFlowAnalysis getTaskAnalysis(UUID taskUuid)
- Parameters:
taskUuid
- UUID of a task that was analyzed.- Returns:
- The control flow analysis for the given task.
- See Also:
ITaskFlowAnalysis
-
isNodePotentiallyReachable
@Deprecated default boolean isNodePotentiallyReachable(NodeKey sourceKey, NodeKey targetKey)
- Parameters:
sourceKey
- Key of the source node to check.targetKey
- Key of the target node to check.- Returns:
- Whether any code path includes a path where the source node was executed at the point in time the target node is about to be executed.
- See Also:
ITaskFlowAnalysis.isPotentiallyReachable(NodeKey, NodeKey)
-
isNodePotentiallyReachable
default boolean isNodePotentiallyReachable(NodeKey sourceKey, NodeKey targetKey, FlowGraphFilter.Generic filter)
- Parameters:
sourceKey
- Key of the source node to check.targetKey
- Key of the target node to check.filter
- Filter applied when traversing the flow graph for finding paths from the source to the target. SeeFlowGraphFilters
for some common filters.- Returns:
- Whether any code path includes a path where the source node was executed at the point in time the target node is about to be executed.
- Since:
- 8.0.0
- See Also:
ITaskFlowAnalysis.isPotentiallyReachable(NodeKey, NodeKey)
-
-