com.qbpsimulator.engine.parser.bpmn

Class BPMN2Parser

java.lang.Object

com.qbpsimulator.engine.parser.bpmn.BPMN2Parser

All Implemented Interfaces:

IProcessModelParser

Direct Known Subclasses:

BPMN2XmlParser

public abstract class BPMN2Parser
extends Object
implements IProcessModelParser

This helper class parses BPMN 2.0 files and creates graph representation of the process graph. Note that the implementation uses JDOM, for simplicity and generality.

Author:

Madis Abel

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,String>	elementIdMap Vertice index to label map
protected Map<String,Integer>	elementMap Activity id to vertex index map
protected Map<String,Integer>	errorHandlerMap processVertice|subProcessVertice|errorCode to vertice index map for error handlers
protected Map<Integer,EventAction>	eventActionMap Vertice index to event action map
protected Map<Integer,EventType>	eventTypeMap Vertice index to event type map
protected Map<Integer,GatewayType>	gatewayMap Vertice index to gateway type map
protected Graph	graph Process graph
protected Map<Integer,Integer[]>	subProcessStartMap Vertice index to sub process start nodes map
protected Set<String>	tasks Set of all tasks

Constructor Summary

Constructors

Constructor and Description
BPMN2Parser() Default constructor

Method Summary

Modifier and Type	Method and Description
Integer[]	getAllStartEventIndexes() Returns start event indexes for the model
Collaboration[]	getCollaborations() Returns all collaborations between elements in the process model
protected List<org.jdom2.Document>	getDocuments()
double	getEdgeProbability(String edgeId) Returns branching probability for an edge
String	getElementSimpleName(Integer verticeIndex) Returns a simple (human-friendly) name for element
int	getErrorHandlerActivity(int processIndex, int subProcessIndex, String errorCode) Returns index of error handler event
EventAction	getEventAction(Integer vertex) Returns action/trigger for event
EventType	getEventType(Integer vertex) Returns type of the event for element
Graph	getGraph() Returns process graph
String	getModelElementId(Integer verticeIndex) Returns id from the model for a vertice index
Integer	getParentBoundaryActivity(Integer boundaryEventIndex) Returns index of activity to which the boundary event is assigned
String	getProcessId(Integer verticeIndex) Returns process id for given element
protected Map<String,org.jdom2.Element>	getProcessRootElements()
Integer[]	getStartEventIndexesForMainProcess() Returns start event indexes for the main process id (to be enabled when simulation is started
Integer[]	getSubProcessStartActivityIndexes(Integer verticeIndex) Returns indexes of start events for sub-process
protected void	initGraph() Initializes graph and detects collaborations
boolean	isChoice(Integer verticeIndex) Returns if element is XOR gateway
boolean	isEventGateway(Integer verticeIndex) Returns if element is event based gateway
boolean	isInterruptingEvent(Integer verticeIndex) Returns if given event is an interrupting event
protected static boolean	isKnownElement(String name) Returns true if element is know.
boolean	isOR(Integer verticeIndex) Returns if element is an OR gateway
boolean	isParallel(Integer verticeIndex) Returns if element is parallel gateway
boolean	isSubProcess(Integer verticeIndex) Returns if element is a sub-process
boolean	isTask(String name) Returns if element is a task
protected void	loadDocuments()
void	parse() Parse the model
protected void	processAllCallActivities() Processes all callActivity elements and associates starts events with it
protected void	processElement(org.jdom2.Element el, Integer fromVertice, String processId) Processes a node in the mode and creates entry in the process graph.
protected void	processElement(String id, org.jdom2.Element elem) Meant to be overridden by child classes for additional known element parsing
void	setFiles(List<String> fileNames) Set input file names to parse
void	setInputStreams(List<InputStream> inputStreams) Set input streams to parse
protected boolean	simulateSubProcessAsTask(String subProcessId)
protected static String	uniqueId(String processId, String elementId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.qbpsimulator.engine.parser.IProcessModelParser

getAllResources, getArrivalRateDistributionInfo, getArrivalRateTimeTable, getElementCostThreshold, getElementDurationInformation, getElementDurationThreshold, getElementFixedCost, getFirstProcessInstanceForStats, getLastProcessInstanceForStats, getStartTime, getTaskResourceId, getTotalProcessInstances, isApplicable

Field Detail

graph

protected Graph graph

Process graph

elementMap

protected Map<String,Integer> elementMap

Activity id to vertex index map

elementIdMap

protected Map<Integer,String> elementIdMap

Vertice index to label map

gatewayMap

protected Map<Integer,GatewayType> gatewayMap

Vertice index to gateway type map

eventTypeMap

protected Map<Integer,EventType> eventTypeMap

Vertice index to event type map

eventActionMap

protected Map<Integer,EventAction> eventActionMap

Vertice index to event action map

subProcessStartMap

protected Map<Integer,Integer[]> subProcessStartMap

Vertice index to sub process start nodes map

errorHandlerMap

protected Map<String,Integer> errorHandlerMap

processVertice|subProcessVertice|errorCode to vertice index map for error handlers

tasks

protected Set<String> tasks

Set of all tasks

Constructor Detail

BPMN2Parser

public BPMN2Parser()

Default constructor

Method Detail

setInputStreams

public void setInputStreams(List<InputStream> inputStreams)

Set input streams to parse

Specified by:

setInputStreams in interface IProcessModelParser

Parameters:

inputStreams - list of input streams to parse

setFiles

public void setFiles(List<String> fileNames)

Set input file names to parse

Specified by:

setFiles in interface IProcessModelParser

Parameters:

fileNames - list of file names to parse

parse

public void parse()
           throws ModelParseException,
                  ProcessValidationException

Description copied from interface: IProcessModelParser

Parse the model

Specified by:

parse in interface IProcessModelParser

Throws:

ProcessValidationException

ModelParseException

uniqueId

protected static String uniqueId(String processId,
                                 String elementId)

loadDocuments

protected void loadDocuments()
                      throws ModelParseException

Throws:

ModelParseException

initGraph

protected void initGraph()
                  throws ProcessValidationException

Initializes graph and detects collaborations

Throws:

ProcessValidationException

isKnownElement

protected static boolean isKnownElement(String name)

Returns true if element is know. Supported sequenceFlow, task, *Event, *Gateway, subProcess, callActivity.

Parameters:

name - element name

Returns:

true if supported element

processElement

protected void processElement(org.jdom2.Element el,
                              Integer fromVertice,
                              String processId)
                       throws ProcessValidationException

Processes a node in the mode and creates entry in the process graph.

Throws:

ProcessValidationException

processAllCallActivities

protected void processAllCallActivities()
                                 throws ProcessValidationException

Processes all callActivity elements and associates starts events with it

Throws:

ProcessValidationException

processElement

protected void processElement(String id,
                              org.jdom2.Element elem)
                       throws ProcessValidationException

Meant to be overridden by child classes for additional known element parsing

Parameters:

id - internal id of the element

elem - Element node to process

Throws:

ProcessValidationException

getAllStartEventIndexes

public Integer[] getAllStartEventIndexes()

Returns start event indexes for the model

Specified by:

getAllStartEventIndexes in interface IProcessModelParser

Returns:

getStartEventIndexesForMainProcess

public Integer[] getStartEventIndexesForMainProcess()
                                             throws ProcessValidationException

Returns start event indexes for the main process id (to be enabled when simulation is started

Specified by:

getStartEventIndexesForMainProcess in interface IProcessModelParser

Returns:

Throws:

ProcessValidationException - if main process cannot be determined

getElementSimpleName

public String getElementSimpleName(Integer verticeIndex)

Returns a simple (human-friendly) name for element

Specified by:

getElementSimpleName in interface IProcessModelParser

Parameters:

verticeIndex - index of element

Returns:

simple name

getProcessId

public String getProcessId(Integer verticeIndex)

Returns process id for given element

Specified by:

getProcessId in interface IProcessModelParser

Parameters:

verticeIndex - index of element

Returns:

id of the process containing the element

getCollaborations

public Collaboration[] getCollaborations()

Returns all collaborations between elements in the process model

Specified by:

getCollaborations in interface IProcessModelParser

Returns:

isInterruptingEvent

public boolean isInterruptingEvent(Integer verticeIndex)

Returns if given event is an interrupting event

Specified by:

isInterruptingEvent in interface IProcessModelParser

Parameters:

verticeIndex - index of an event

Returns:

true if event interrupts the main flow, otherwise false

getParentBoundaryActivity

public Integer getParentBoundaryActivity(Integer boundaryEventIndex)

Returns index of activity to which the boundary event is assigned

Specified by:

getParentBoundaryActivity in interface IProcessModelParser

Parameters:

boundaryEventIndex - index of a boundary event

Returns:

index of activity with assigned boundary event

getEdgeProbability

public double getEdgeProbability(String edgeId)
                          throws ProcessValidationException

Description copied from interface: IProcessModelParser

Returns branching probability for an edge

Specified by:

getEdgeProbability in interface IProcessModelParser

Parameters:

edgeId - edge id from the mode

Returns:

branching probability [0..1]

Throws:

ProcessValidationException

getModelElementId

public String getModelElementId(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns id from the model for a vertice index

Specified by:

getModelElementId in interface IProcessModelParser

Parameters:

verticeIndex - element index from process graph

isParallel

public boolean isParallel(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns if element is parallel gateway

Specified by:

isParallel in interface IProcessModelParser

Parameters:

verticeIndex - element index from process graph

isChoice

public boolean isChoice(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns if element is XOR gateway

Specified by:

isChoice in interface IProcessModelParser

isEventGateway

public boolean isEventGateway(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns if element is event based gateway

Specified by:

isEventGateway in interface IProcessModelParser

getGraph

public Graph getGraph()

Description copied from interface: IProcessModelParser

Returns process graph

Specified by:

getGraph in interface IProcessModelParser

isTask

public boolean isTask(String name)

Description copied from interface: IProcessModelParser

Returns if element is a task

Specified by:

isTask in interface IProcessModelParser

Parameters:

name - name of the task

Returns:

getEventType

public EventType getEventType(Integer vertex)

Description copied from interface: IProcessModelParser

Returns type of the event for element

Specified by:

getEventType in interface IProcessModelParser

Parameters:

vertex - element index

Returns:

getEventAction

public EventAction getEventAction(Integer vertex)

Description copied from interface: IProcessModelParser

Returns action/trigger for event

Specified by:

getEventAction in interface IProcessModelParser

Parameters:

vertex - element index

Returns:

getSubProcessStartActivityIndexes

public Integer[] getSubProcessStartActivityIndexes(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns indexes of start events for sub-process

Specified by:

getSubProcessStartActivityIndexes in interface IProcessModelParser

Parameters:

verticeIndex - index of sub-process activity

Returns:

getErrorHandlerActivity

public int getErrorHandlerActivity(int processIndex,
                                   int subProcessIndex,
                                   String errorCode)

Description copied from interface: IProcessModelParser

Returns index of error handler event

Specified by:

getErrorHandlerActivity in interface IProcessModelParser

Parameters:

processIndex - index of parent process

subProcessIndex - index of sub-process

errorCode - event code to handle

Returns:

index of catch event

isSubProcess

public boolean isSubProcess(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns if element is a sub-process

Specified by:

isSubProcess in interface IProcessModelParser

Parameters:

verticeIndex - index of element

Returns:

isOR

public boolean isOR(Integer verticeIndex)

Description copied from interface: IProcessModelParser

Returns if element is an OR gateway

Specified by:

isOR in interface IProcessModelParser

Parameters:

verticeIndex - index of an element

getDocuments

protected List<org.jdom2.Document> getDocuments()

getProcessRootElements

protected Map<String,org.jdom2.Element> getProcessRootElements()

simulateSubProcessAsTask

protected boolean simulateSubProcessAsTask(String subProcessId)