Package de.xima.fc.interfaces.workflow.analysis

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

Modifier and Type	Method	Description
IFlowGraphEndPoints	getEndPoints(INodeKeyProviding node)	Convenience method for obtaining the task analysis, then using it to obtain the end points.
default Set<NodeKey>	getPotentialPredecessorsOf(NodeKey targetKey)	Deprecated. Use getPotentialPredecessorsOf(targetKey, FlowGraphFilters.matchAll())
default Set<NodeKey>	getPotentialPredecessorsOf(NodeKey targetKey, FlowGraphFilter.Backward filter)
default Set<NodeKey>	getPotentialSuccessorsOf(NodeKey sourceKey)	Deprecated. Use getPotentialSuccessorsOf(sourceKey, FlowGraphFilters.matchAll()).
default Set<NodeKey>	getPotentialSuccessorsOf(NodeKey sourceKey, FlowGraphFilter.Forward filter)
default ITaskFlowAnalysis	getTaskAnalysis(IUuidProviding task)
ITaskFlowAnalysis	getTaskAnalysis(UUID taskUuid)
default boolean	isNodePotentiallyReachable(NodeKey sourceKey, NodeKey targetKey)	Deprecated. Use isNodePotentiallyReachable(sourceKey, targetKey, FlowGraphFilters.matchAll()).
default boolean	isNodePotentiallyReachable(NodeKey sourceKey, NodeKey targetKey, FlowGraphFilter.Generic filter)

Method Detail

getPotentialPredecessorsOf

@Deprecated
default Set<NodeKey> getPotentialPredecessorsOf(NodeKey targetKey)

Deprecated.

Use getPotentialPredecessorsOf(targetKey, FlowGraphFilters.matchAll())

Parameters:

targetKey - The key of the target node to check.

Returns:

The keys of all nodes for which isNodePotentiallyReachable(nodeUuid, targetUuid) returns true.

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. See FlowGraphFilters for some common filters.

Returns:

The keys of all nodes for which isNodePotentiallyReachable(nodeUuid, targetUuid) returns true.

Since:

8.0.0

See Also:

ITaskFlowAnalysis.getPotentialPredecessorsOf(NodeKey, FlowGraphFilter.Backward)

getPotentialSuccessorsOf

@Deprecated
default Set<NodeKey> getPotentialSuccessorsOf(NodeKey sourceKey)

Deprecated.

Use getPotentialSuccessorsOf(sourceKey, FlowGraphFilters.matchAll()).

Parameters:

sourceKey - The key of the target node to check.

Returns:

The keys of all nodes for which isNodePotentiallyReachable(sourceUuid, nodeUuid) returns true.

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. See FlowGraphFilters for some common filters.

Returns:

The keys of all nodes for which isNodePotentiallyReachable(sourceUuid, nodeUuid) returns true.

Since:

8.0.0

See Also:

ITaskFlowAnalysis.getPotentialSuccessorsOf(NodeKey, FlowGraphFilter.Forward)

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

getTaskAnalysis

default ITaskFlowAnalysis getTaskAnalysis(IUuidProviding task)

Parameters:

task - Task that was analyzed.

Returns:

The control flow analysis for the given task.

Since:

8.4.0

See Also:

ITaskFlowAnalysis

getEndPoints

IFlowGraphEndPoints getEndPoints(INodeKeyProviding node)

Convenience method for obtaining the task analysis, then using it to obtain the end points.

Parameters:

node - Node for which to find the end points.

Returns:

The end points of the given node. Never null, but might be empty if a non-existing node was given.

Since:

8.4.0

isNodePotentiallyReachable

@Deprecated
default boolean isNodePotentiallyReachable(NodeKey sourceKey,
                                           NodeKey targetKey)

Deprecated.

Use isNodePotentiallyReachable(sourceKey, targetKey, FlowGraphFilters.matchAll()).

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, FlowGraphFilter.Generic)

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. See FlowGraphFilters 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, FlowGraphFilter.Generic)