Enum FcForEachLoopBpmnModeler

java.lang.Object

java.lang.Enum<FcForEachLoopBpmnModeler>

de.xima.fc.workflow.designer.bpmn.node.flow_control.FcForEachLoopBpmnModeler

All Implemented Interfaces:

IWorkflowNodeBpmnModeler<FcForEachLoopProps>, Serializable, Comparable<FcForEachLoopBpmnModeler>

public enum FcForEachLoopBpmnModeler
extends Enum<FcForEachLoopBpmnModeler>
implements IWorkflowNodeBpmnModeler<FcForEachLoopProps>

BPMN modeler for nodes of type for each loop. Creates a sub process with the loop body and uses escalations for continue / break statements.

Horizontal

Without break / continue

With break

With continue

With break and continue

Vertical

Without break / continue

With break

With continue

With break and continue

Since:

8.4.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The immutable singleton instance of this modeler.

Method Summary

Modifier and Type	Method	Description
void	modelNode(IModelWorkflowNodeParams<FcForEachLoopProps> params, IWorkflowBpmnModelContext context)	Models a WorkflowNode in the BPMN diagram.
static FcForEachLoopBpmnModeler	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FcForEachLoopBpmnModeler[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final FcForEachLoopBpmnModeler INSTANCE

The immutable singleton instance of this modeler.

Method Details

values

public static FcForEachLoopBpmnModeler[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FcForEachLoopBpmnModeler valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

modelNode

public void modelNode(IModelWorkflowNodeParams<FcForEachLoopProps> params,
 IWorkflowBpmnModelContext context)

Description copied from interface: IWorkflowNodeBpmnModeler

Models a WorkflowNode in the BPMN diagram. This method is called once for the root node of each WorkflowTask in the workflow. Implementations for nodes that have children should call context.modelNode(node) on their child nodes if needed.

The responsibility of each modeler is to access the provided params.partBuilder() and add the appropriate data to that builder. That data then gets used to create a IStructuredBpmnModelPart for the node, see the class-level documentation of IStructuredBpmnModelPart for more info.

When modelling a workflow node as BPMN, the usual approach is to create a nested tree of alignment items, making use of the layouter. This tree then gets resolved to a flat map. Finally, the various method on IFlattenedAlignmentItemMap can be used to create the BPMN shapes, BPMN edges and sequence flows.

Specified by:

modelNode in interface IWorkflowNodeBpmnModeler<FcForEachLoopProps>

Parameters:

params - The parameters for the modeler, containing the WorkflowNode to model and its deserialized custom properties model, as well as the part builder to fill with data.

context - The context for creating the BPMN diagram, its lifecycle starts when the conversion (of the workflow to a BPMN diagram) starts and ends when the conversion ends. The context lets you access various helper methods such as the layouter() or colorizer, and also provides access to all global data such as all triggers and nodes in the workflow.