org.camunda.community.bpmndt

Class BpmnSupport

java.lang.Object

org.camunda.community.bpmndt.BpmnSupport

public class BpmnSupport
extends Object

BPMN model instance support, allows easier working with the flow nodes of a Process and the test cases, defined as bpmndt extension elements.

Method Summary

Modifier and Type	Method and Description
org.camunda.bpm.model.bpmn.instance.FlowNode	get(String flowNodeId)
Path	getFile()
org.camunda.bpm.model.bpmn.instance.MultiInstanceLoopCharacteristics	getMultiInstance(String flowNodeId) Gets the multi instance loop characteristics from the flow node with the given ID.
String	getParentElementId(String flowNodeId) Returns the ID of the parent element, which can be the ID of the process, an embedded sub process or a transaction.
String	getProcessId()
List<TestCase>	getTestCases()
String	getTopicName(String flowNodeId)
boolean	has(String flowNodeId)
protected boolean	is(String flowNodeId, String typeName)
boolean	isBoundaryEvent(String flowNodeId)
boolean	isCallActivity(String flowNodeId)
boolean	isEventBasedGateway(String flowNodeId)
boolean	isExternalTask(String flowNodeId)
boolean	isIntermediateCatchEvent(String flowNodeId)
boolean	isProcessEnd(String flowNodeId) Determines if the flow node with the given ID ends the process or not.
boolean	isReceiveTask(String flowNodeId)
boolean	isUserTask(String flowNodeId)
static BpmnSupport	of(Path bpmnFile)
static String	toJavaLiteral(String id) Converts the given BPMN element ID into a Java literal, which can be used when generating source code.
static String	toLiteral(String id) Converts the given BPMN element ID into a literal, which can be used when generating source code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static BpmnSupport of(Path bpmnFile)

toJavaLiteral

public static String toJavaLiteral(String id)

Converts the given BPMN element ID into a Java literal, which can be used when generating source code. The convertion lowers all characters and retains letters as well as digits. All other characters are converted into underscores. If the literal starts with a digit, an additional underscore is prepended.

Parameters:

id - The ID of a specific flow node or process.

Returns:

A Java conform literal.

toLiteral

public static String toLiteral(String id)

Converts the given BPMN element ID into a literal, which can be used when generating source code. The convertion retains letters and digits. All other characters are converted into underscores. Moreover upper case is also retained.

Parameters:

id - The ID of a specific flow node or process.

Returns:

A conform literal.

get

public org.camunda.bpm.model.bpmn.instance.FlowNode get(String flowNodeId)

getFile

public Path getFile()

getMultiInstance

public org.camunda.bpm.model.bpmn.instance.MultiInstanceLoopCharacteristics getMultiInstance(String flowNodeId)

Gets the multi instance loop characteristics from the flow node with the given ID.

Parameters:

flowNodeId - A specific flow node ID.

Returns:

The characteristics or null, if the flow node does not exist or does not have such loop characteristics.

getParentElementId

public String getParentElementId(String flowNodeId)

Returns the ID of the parent element, which can be the ID of the process, an embedded sub process or a transaction.

Parameters:

flowNodeId - A specific flow node ID.

Returns:

The parent element ID or null, if the flow node with the given ID does not exist, has no parent element or the parent element is not of type BaseElement.

getProcessId

public String getProcessId()

getTestCases

public List<TestCase> getTestCases()

getTopicName

public String getTopicName(String flowNodeId)

has

public boolean has(String flowNodeId)

is

protected boolean is(String flowNodeId,
                     String typeName)

isBoundaryEvent

public boolean isBoundaryEvent(String flowNodeId)

isCallActivity

public boolean isCallActivity(String flowNodeId)

isEventBasedGateway

public boolean isEventBasedGateway(String flowNodeId)

isExternalTask

public boolean isExternalTask(String flowNodeId)

isIntermediateCatchEvent

public boolean isIntermediateCatchEvent(String flowNodeId)

isProcessEnd

public boolean isProcessEnd(String flowNodeId)

Determines if the flow node with the given ID ends the process or not. This is the case if it exists, if it is an end event and if the parent element is a process.

Parameters:

flowNodeId - A specific flow node ID.

Returns:

true, if the flow node ends the process. Otherwise false.

isReceiveTask

public boolean isReceiveTask(String flowNodeId)

isUserTask

public boolean isUserTask(String flowNodeId)