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

Interface ICreateFlowGraphContext<TElement extends IWorkflowNodeTypeProviding>

Type Parameters:

TElement - The type of the node elements on which the analysis is performed. This type may be different depending on whether the analysis is performed on the backend data model WorkflowNode or the frontend view model.

public interface ICreateFlowGraphContext<TElement extends IWorkflowNodeTypeProviding>

Context provided to the node handlers during a call to createFlowGraph. See that method for more details on flow graphs. Handlers may use this context to recursively analyze their children as well.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
int	childCount(TElement node)
default void	connect(com.google.common.collect.ImmutableSet<NodeKey> from, INodeKeyProviding to, IFlowGraphEdgeDataConfigurator data)	For each source in from, adds an edge (source, to) to the flow graph.
default void	connect(com.google.common.collect.ImmutableSet<NodeKey> from, NodeKey to)	Deprecated. Use connect(ImmutableSet, NodeKey, IFlowGraphEdgeDataConfigurator).
void	connect(com.google.common.collect.ImmutableSet<NodeKey> from, NodeKey to, IFlowGraphEdgeDataConfigurator data)	For each source in from, adds an edge (source, to) to the flow graph.
default void	connect(com.google.common.collect.ImmutableSet<NodeKey> from, TElement toParent, int toChildIndex)	Deprecated. Use connect(ImmutableSet, IWorkflowNodeTypeProviding, int, IFlowGraphEdgeDataConfigurator).
void	connect(com.google.common.collect.ImmutableSet<NodeKey> from, TElement toParent, int toChildIndex, IFlowGraphEdgeDataConfigurator data)	Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.
void	connect(com.google.common.collect.ImmutableSet<NodeKey> from, TElement to, IFlowGraphEdgeDataConfigurator data)	Adds an edge (from, child) to the flow graph for every element in the set of from nodes.
default void	connect(INodeKeyProviding from, INodeKeyProviding to, IFlowGraphEdgeDataConfigurator data)	Adds an edge (from, to) to the flow graph.
default void	connect(INodeKeyProviding from, TElement toParent, int toChildIndex, IFlowGraphEdgeDataConfigurator data)	Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.
default void	connect(NodeKey from, NodeKey to)	Deprecated. Use connect(NodeKey, NodeKey, IFlowGraphEdgeDataConfigurator).
void	connect(NodeKey from, NodeKey to, IFlowGraphEdgeDataConfigurator data)	Adds an edge (from, to) to the flow graph.
void	connect(NodeKey from, TElement toParent, int toChildIndex, IFlowGraphEdgeDataConfigurator data)	Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.
default void	connect(TElement from, TElement to)	Deprecated. Use connect(IWorkflowNodeTypeProviding, IWorkflowNodeTypeProviding, IFlowGraphEdgeDataConfigurator).
void	connect(TElement from, TElement to, IFlowGraphEdgeDataConfigurator data)	Adds an edge (from, to) to the flow graph.
void	connectChildToParent(TElement parent, int childIndex, IFlowGraphEdgeDataConfigurator data)	Finds the child at the given index in the toParent and adds an edge (child, parent) to the flow graph.
default void	connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from, INodeKeyProviding to, IFlowGraphEdgeDataConfigurator data)	For each source in from, adds an edge (source, to) to the flow graph.
void	connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from, NodeKey to, IFlowGraphEdgeDataConfigurator data)	For each source in from, adds an edge (source, to) to the flow graph.
void	connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from, TElement toParent, int toChildIndex, IFlowGraphEdgeDataConfigurator data)	Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.
void	connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from, TElement to, IFlowGraphEdgeDataConfigurator data)	Adds an edge (from, child) to the flow graph for every element in the set of from nodes.
default void	connectParentToChild(TElement parent, int childIndex)	Deprecated. Use connectParentToChild(IWorkflowNodeTypeProviding, int, IFlowGraphEdgeDataConfigurator).
void	connectParentToChild(TElement parent, int childIndex, IFlowGraphEdgeDataConfigurator data)	Adds an edge (parent, parent[childIndex]) to the flow graph.
IFlowGraphEndPoints	createFlowGraph(TElement node)	Creates the flow graph for the given node and return its end points.
IFlowGraphEndPoints	createFlowGraphForChild(TElement parent, int childIndex)	Creates the flow graph for the given node and return its end points.
NodeKey	createNodeKey(TElement element)	Creates the element key that needs to be entered in the list of potentially reachable nodes.
IFlowGraphEndPoints	endPoints(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Normal> normalEndPoints, com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Throwing> throwingEndPoints, com.google.common.collect.ImmutableSet<FlowGraphEndPoint.ControlTransfer> controlTransferEndPoints, com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Returning> returningEndPoints)
default IFlowGraphEndPoints	endPoints(com.google.common.collect.ImmutableSet<NodeKey> normalEndPoints, com.google.common.collect.ImmutableSet<NodeKey> throwingEndPoints)	Deprecated. Use endPoints(ImmutableSet, ImmutableSet, ImmutableSet, ImmutableSet).
IFlowGraphEndPoints	endPointsAlwaysNormal(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Normal> normalEndPoints)	Creates the end points for a node that always completes normally and never throws or returns.
default IFlowGraphEndPoints	endPointsAlwaysReturning()	Deprecated. Returning end points are not handled separately, use endPointsAlwaysReturning(ImmutableSet).
IFlowGraphEndPoints	endPointsAlwaysReturning(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Returning> returningEndPoints)	Creates the end points for a node that always returns.
IFlowGraphEndPoints	endPointsAlwaysThrowing(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Throwing> throwingEndPoints)	Creates the end points for a node that always throws an exception.
IFlowGraphEndPoints	endPointsAlwaysTransferringControl(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.ControlTransfer> controlTransferEndPoints)	Creates the end points for a node that always transfers control and never completes normally and never throws.
default IFlowGraphEndPoints	endPointsNeverNormal(com.google.common.collect.ImmutableSet<NodeKey> throwingEndPoints)	Deprecated. Use endPointsAlwaysThrowing(ImmutableSet).
default IFlowGraphEndPoints	endPointsNeverThrowing(com.google.common.collect.ImmutableSet<NodeKey> normalEndPoints)	Deprecated. Use endPointsAlwaysNormal(ImmutableSet).
default IFlowGraphEndPoints	endPointsSameNormalAndThrowing(com.google.common.collect.ImmutableSet<NodeKey> endPoints)	Deprecated. Use endPoints(ImmutableSet, ImmutableSet, ImmutableSet, ImmutableSet).
boolean	isHasChild(TElement node, int childIndex)
<E> com.google.common.collect.ImmutableSet<E>	union(com.google.common.collect.ImmutableSet<E>... sets)	Helper method that computes the union of all given sets.
<E> com.google.common.collect.ImmutableSet<E>	union(com.google.common.collect.ImmutableSet<E> set1, com.google.common.collect.ImmutableSet<E> set2)	Helper method that computes the union of all given sets.
<E> com.google.common.collect.ImmutableSet<E>	union(E endPoint, com.google.common.collect.ImmutableSet<E> set)	Helper method that computes the union of the given key with all items of the give set.
<E> com.google.common.collect.ImmutableSet<E>	union(Iterable<com.google.common.collect.ImmutableSet<E>> sets)	Helper method that computes the union of all given sets.

Method Detail

childCount

int childCount(TElement node)

Parameters:

node - Node to check.

Returns:

Number of children the given node contains.

connect

default void connect(INodeKeyProviding from,
                     INodeKeyProviding to,
                     IFlowGraphEdgeDataConfigurator data)

Adds an edge (from, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

default void connect(INodeKeyProviding from,
                     TElement toParent,
                     int toChildIndex,
                     IFlowGraphEdgeDataConfigurator data)

Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.

Parameters:

from - Source node.

toParent - Parent with the target node.

toChildIndex - Index of the target node in the parent node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

default void connect(com.google.common.collect.ImmutableSet<NodeKey> from,
                     INodeKeyProviding to,
                     IFlowGraphEdgeDataConfigurator data)

For each source in from, adds an edge (source, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

@Deprecated
default void connect(com.google.common.collect.ImmutableSet<NodeKey> from,
                     NodeKey to)

Deprecated.

Use connect(ImmutableSet, NodeKey, IFlowGraphEdgeDataConfigurator).

For each source in from, adds an edge (source, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

connect

void connect(com.google.common.collect.ImmutableSet<NodeKey> from,
             NodeKey to,
             IFlowGraphEdgeDataConfigurator data)

For each source in from, adds an edge (source, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

void connect(com.google.common.collect.ImmutableSet<NodeKey> from,
             TElement to,
             IFlowGraphEdgeDataConfigurator data)

Adds an edge (from, child) to the flow graph for every element in the set of from nodes.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.1.0

See Also:

etc. for standard implementations.

connect

@Deprecated
default void connect(com.google.common.collect.ImmutableSet<NodeKey> from,
                     TElement toParent,
                     int toChildIndex)

Deprecated.

Use connect(ImmutableSet, IWorkflowNodeTypeProviding, int, IFlowGraphEdgeDataConfigurator).

Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.

Parameters:

from - Source node.

toParent - Parent with the target node.

toChildIndex - Index of the target node in the parent node.

connect

void connect(com.google.common.collect.ImmutableSet<NodeKey> from,
             TElement toParent,
             int toChildIndex,
             IFlowGraphEdgeDataConfigurator data)

Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.

Parameters:

from - Source node.

toParent - Parent with the target node.

toChildIndex - Index of the target node in the parent node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

@Deprecated
default void connect(NodeKey from,
                     NodeKey to)

Deprecated.

Use connect(NodeKey, NodeKey, IFlowGraphEdgeDataConfigurator).

Adds an edge (from, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

connect

void connect(NodeKey from,
             NodeKey to,
             IFlowGraphEdgeDataConfigurator data)

Adds an edge (from, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

void connect(NodeKey from,
             TElement toParent,
             int toChildIndex,
             IFlowGraphEdgeDataConfigurator data)

Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.

Parameters:

from - Source node.

toParent - Parent with the target node.

toChildIndex - Index of the target node in the parent node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connect

@Deprecated
default void connect(TElement from,
                     TElement to)

Deprecated.

Use connect(IWorkflowNodeTypeProviding, IWorkflowNodeTypeProviding, IFlowGraphEdgeDataConfigurator).

Adds an edge (from, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

connect

void connect(TElement from,
             TElement to,
             IFlowGraphEdgeDataConfigurator data)

Adds an edge (from, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

connectChildToParent

void connectChildToParent(TElement parent,
                          int childIndex,
                          IFlowGraphEdgeDataConfigurator data)

Finds the child at the given index in the toParent and adds an edge (child, parent) to the flow graph.

Parameters:

parent - Parent node to which to draw a connection.

childIndex - Index of the child from which to draw a connection.

data - For setting the edge data on the added edges.

Since:

8.1.0

See Also:

etc. for standard implementations.

connectEndPoints

default void connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from,
                              INodeKeyProviding to,
                              IFlowGraphEdgeDataConfigurator data)

For each source in from, adds an edge (source, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.1.0

See Also:

etc. for standard implementations.

connectEndPoints

void connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from,
                      NodeKey to,
                      IFlowGraphEdgeDataConfigurator data)

For each source in from, adds an edge (source, to) to the flow graph.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.1.0

See Also:

etc. for standard implementations.

connectEndPoints

void connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from,
                      TElement to,
                      IFlowGraphEdgeDataConfigurator data)

Adds an edge (from, child) to the flow graph for every element in the set of from nodes.

Parameters:

from - Source node.

to - Target node.

data - For setting the edge data on the added edges.

Since:

8.1.0

See Also:

etc. for standard implementations.

connectEndPoints

void connectEndPoints(com.google.common.collect.ImmutableSet<? extends INodeKeyProviding> from,
                      TElement toParent,
                      int toChildIndex,
                      IFlowGraphEdgeDataConfigurator data)

Finds the child at the given index in the toParent and adds an edge (from, child) to the flow graph.

Parameters:

from - Source node.

toParent - Parent with the target node.

toChildIndex - Index of the target node in the parent node.

data - For setting the edge data on the added edges.

Since:

8.1.0

See Also:

etc. for standard implementations.

connectParentToChild

@Deprecated
default void connectParentToChild(TElement parent,
                                  int childIndex)

Deprecated.

Use connectParentToChild(IWorkflowNodeTypeProviding, int, IFlowGraphEdgeDataConfigurator).

Finds the child at the given index in the toParent and adds an edge (parent, child) to the flow graph.

Parameters:

parent - Parent node from which to draw a connection.

childIndex - Index of the parent's child to which to draw a connection.

connectParentToChild

void connectParentToChild(TElement parent,
                          int childIndex,
                          IFlowGraphEdgeDataConfigurator data)

Adds an edge (parent, parent[childIndex]) to the flow graph.

Parameters:

parent - Parent node from which to draw a connection.

childIndex - Index of the parent's child to which to draw a connection.

data - For setting the edge data on the added edges.

Since:

8.0.0

See Also:

etc. for standard implementations.

createFlowGraph

IFlowGraphEndPoints createFlowGraph(TElement node)
                             throws WorkflowAnalysisException

Creates the flow graph for the given node and return its end points.

Parameters:

node - Child to analyze.

Returns:

The end points of the given node.

Throws:

WorkflowAnalysisException - When the analysis could not be completed, usually because a child threw an exception.

createFlowGraphForChild

IFlowGraphEndPoints createFlowGraphForChild(TElement parent,
                                            int childIndex)
                                     throws WorkflowAnalysisException

Creates the flow graph for the given node and return its end points.

Parameters:

parent - Parent node with a child to analyze.

childIndex - Index of the child to analyze.

Returns:

The end points of the given node.

Throws:

WorkflowAnalysisException - When the analysis could not be completed, usually because a child threw an exception.

createNodeKey

NodeKey createNodeKey(TElement element)

Creates the element key that needs to be entered in the list of potentially reachable nodes.

Parameters:

element - Element for which to create the key.

Returns:

The key of the element.

endPoints

IFlowGraphEndPoints endPoints(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Normal> normalEndPoints,
                              com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Throwing> throwingEndPoints,
                              com.google.common.collect.ImmutableSet<FlowGraphEndPoint.ControlTransfer> controlTransferEndPoints,
                              com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Returning> returningEndPoints)

Parameters:

normalEndPoints - The normal end points, see IFlowGraphEndPoints.getNormal()

throwingEndPoints - The throwing end points, see IFlowGraphEndPoints.getThrowing().

controlTransferEndPoints - The control transfer end points, see IFlowGraphEndPoints.getControlTransfer().

returningEndPoints - The returning end points, see IFlowGraphEndPoints.getReturning().

Returns:

A new end points POJO instance with the given data.

Since:

8.1.0

endPoints

@Deprecated
default IFlowGraphEndPoints endPoints(com.google.common.collect.ImmutableSet<NodeKey> normalEndPoints,
                                      com.google.common.collect.ImmutableSet<NodeKey> throwingEndPoints)

Deprecated.

Use endPoints(ImmutableSet, ImmutableSet, ImmutableSet, ImmutableSet).

Parameters:

normalEndPoints - The normal end points, see IFlowGraphEndPoints.getNormal()

throwingEndPoints - The throwing end points, see IFlowGraphEndPoints.getThrowing().

Returns:

A new end points POJO instance with the given data.

endPointsAlwaysNormal

IFlowGraphEndPoints endPointsAlwaysNormal(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Normal> normalEndPoints)

Creates the end points for a node that always completes normally and never throws or returns.

Parameters:

normalEndPoints - The normal end points, see IFlowGraphEndPoints.getNormal().

Returns:

A new end points POJO instance with the given data and all other end points set to an empty set.

endPointsAlwaysReturning

@Deprecated
default IFlowGraphEndPoints endPointsAlwaysReturning()

Deprecated.

Returning end points are not handled separately, use endPointsAlwaysReturning(ImmutableSet).

Returns:

A new POJO with no normal and no throwing end points.

endPointsAlwaysReturning

IFlowGraphEndPoints endPointsAlwaysReturning(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Returning> returningEndPoints)

Creates the end points for a node that always returns.

Parameters:

returningEndPoints - The returning end points, see IFlowGraphEndPoints.getReturning().

Returns:

A new end points POJO instance with the given data and all other end points set to an empty set.

Since:

8.1.0

endPointsAlwaysThrowing

IFlowGraphEndPoints endPointsAlwaysThrowing(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.Throwing> throwingEndPoints)

Creates the end points for a node that always throws an exception.

Parameters:

throwingEndPoints - The throwing end points, see IFlowGraphEndPoints.getThrowing().

Returns:

A new end points POJO instance with the given data and all other end points set to an empty set.

endPointsAlwaysTransferringControl

IFlowGraphEndPoints endPointsAlwaysTransferringControl(com.google.common.collect.ImmutableSet<FlowGraphEndPoint.ControlTransfer> controlTransferEndPoints)

Creates the end points for a node that always transfers control and never completes normally and never throws.

Parameters:

controlTransferEndPoints - The control transfer end points, see IFlowGraphEndPoints.getControlTransfer().

Returns:

A new end points POJO instance with the given data and all other end points set to an empty set.

endPointsNeverNormal

@Deprecated
default IFlowGraphEndPoints endPointsNeverNormal(com.google.common.collect.ImmutableSet<NodeKey> throwingEndPoints)

Deprecated.

Use endPointsAlwaysThrowing(ImmutableSet).

Parameters:

throwingEndPoints - The value for both IFlowGraphEndPoints.getThrowingEndPoints().

Returns:

A new POJO with the given data and IFlowGraphEndPoints.getNormalEndPoints() set to an empty set.

endPointsNeverThrowing

@Deprecated
default IFlowGraphEndPoints endPointsNeverThrowing(com.google.common.collect.ImmutableSet<NodeKey> normalEndPoints)

Deprecated.

Use endPointsAlwaysNormal(ImmutableSet).

Parameters:

normalEndPoints - The value for both IFlowGraphEndPoints.getNormalEndPoints().

Returns:

A new POJO with the given data and IFlowGraphEndPoints.getThrowingEndPoints() set to an empty set.

endPointsSameNormalAndThrowing

@Deprecated
default IFlowGraphEndPoints endPointsSameNormalAndThrowing(com.google.common.collect.ImmutableSet<NodeKey> endPoints)

Deprecated.

Use endPoints(ImmutableSet, ImmutableSet, ImmutableSet, ImmutableSet).

Parameters:

endPoints - The value for both IFlowGraphEndPoints.getNormalEndPoints() and IFlowGraphEndPoints.getThrowingEndPoints().

Returns:

A new POJO with the given data.

isHasChild

boolean isHasChild(TElement node,
                   int childIndex)

Parameters:

node - Node to check.

childIndex - Index to check.

Returns:

true when the node has a child at the given index, false otherwise.

union

<E> com.google.common.collect.ImmutableSet<E> union(E endPoint,
                                                    com.google.common.collect.ImmutableSet<E> set)

Helper method that computes the union of the given key with all items of the give set.

Parameters:

endPoint - An end point to combine with the set.

set - A set to combine with the key.

Returns:

A set representing the union of all given keys.

union

<E> com.google.common.collect.ImmutableSet<E> union(com.google.common.collect.ImmutableSet<E>... sets)

Helper method that computes the union of all given sets.

Parameters:

sets - More sets to unite.

Returns:

A set representing the union of all input sets.

union

<E> com.google.common.collect.ImmutableSet<E> union(com.google.common.collect.ImmutableSet<E> set1,
                                                    com.google.common.collect.ImmutableSet<E> set2)

Helper method that computes the union of all given sets.

Parameters:

set1 - One set to combined.

set2 - Another set to combined.

Returns:

A set representing the union of all input sets.

union

<E> com.google.common.collect.ImmutableSet<E> union(Iterable<com.google.common.collect.ImmutableSet<E>> sets)

Helper method that computes the union of all given sets.

Parameters:

sets - More sets to unite.

Returns:

A set representing the union of all input sets.