com.qbpsimulator.engine.parser

Interface IProcessModelParser

All Known Implementing Classes:

BPMN2Parser, BPMN2XmlParser

public interface IProcessModelParser

Method Summary

Modifier and Type	Method and Description
List<Resource>	getAllResources() Returns all available resources.
Integer[]	getAllStartEventIndexes() Returns start event indexes for all models
DistributionInfo	getArrivalRateDistributionInfo() Gets distribution information for arrival rate.
TimeTable	getArrivalRateTimeTable() Return timetable with conditions in which time range process instances are created
Collaboration[]	getCollaborations() Returns all collaborations between elements in the process model
double	getEdgeProbability(String edgeId) Returns branching probability for an edge
double	getElementCostThreshold(String elementId) Return cost threshold for element.
DistributionInfo	getElementDurationInformation(String elementId) Returns duration info for element in the process model
double	getElementDurationThreshold(String elementId) Return duration threshold for element in seconds.
double	getElementFixedCost(String elementId) Return fixed (constant) cost for executing element
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
int	getFirstProcessInstanceForStats() First process instance to start calculating statistics from (included).
Graph	getGraph() Returns process graph
int	getLastProcessInstanceForStats() Last process instance to calculate statistics from (excluded).
String	getModelElementId(Integer vertex) 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
Integer[]	getStartEventIndexesForMainProcess() Returns start event indexes for the main process model
Date	getStartTime() Returns the start timestamp for simulation.
Integer[]	getSubProcessStartActivityIndexes(Integer verticeIndex) Returns indexes of start events for sub-process
String	getTaskResourceId(String activityId) Returns resource name for the activity
int	getTotalProcessInstances() Returns total number of process instances to create
boolean	isApplicable() Detect if parser can be applied to the BP model and contains parser specific simulation info
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
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
void	parse() Parse the model
void	setFiles(List<String> fileNames) Set input file names to parse
void	setInputStreams(List<InputStream> inputStreams) Set input streams to parse

Method Detail

getGraph

Graph getGraph()

Returns process graph

getCollaborations

Collaboration[] getCollaborations()

Returns all collaborations between elements in the process model

Returns:

getErrorHandlerActivity

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

Returns index of error handler event

Parameters:

processIndex - index of parent process

subProcessIndex - index of sub-process

errorCode - event code to handle

Returns:

index of catch event

getEventAction

EventAction getEventAction(Integer vertex)

Returns action/trigger for event

Parameters:

vertex - element index

Returns:

getEventType

EventType getEventType(Integer vertex)

Returns type of the event for element

Parameters:

vertex - element index

Returns:

getModelElementId

String getModelElementId(Integer vertex)

Returns id from the model for a vertice index

Parameters:

vertex - element index from process graph

getParentBoundaryActivity

Integer getParentBoundaryActivity(Integer boundaryEventIndex)

Returns index of activity to which the boundary event is assigned

Parameters:

boundaryEventIndex - index of a boundary event

Returns:

index of activity with assigned boundary event

getProcessId

String getProcessId(Integer verticeIndex)

Returns process id for given element

Parameters:

verticeIndex - index of element

Returns:

id of the process containing the element

getElementSimpleName

String getElementSimpleName(Integer verticeIndex)

Returns a simple (human-friendly) name for element

Parameters:

verticeIndex - index of element

Returns:

simple name

getAllStartEventIndexes

Integer[] getAllStartEventIndexes()

Returns start event indexes for all models

Returns:

getStartEventIndexesForMainProcess

Integer[] getStartEventIndexesForMainProcess()
                                      throws ProcessValidationException

Returns start event indexes for the main process model

Returns:

Throws:

ProcessValidationException

getSubProcessStartActivityIndexes

Integer[] getSubProcessStartActivityIndexes(Integer verticeIndex)

Returns indexes of start events for sub-process

Parameters:

verticeIndex - index of sub-process activity

Returns:

isInterruptingEvent

boolean isInterruptingEvent(Integer verticeIndex)

Returns if given event is an interrupting event

Parameters:

verticeIndex - index of an event

Returns:

true if event interrupts the main flow, otherwise false

isChoice

boolean isChoice(Integer verticeIndex)

Returns if element is XOR gateway

Parameters:

vertex - element index from process graph

isEventGateway

boolean isEventGateway(Integer verticeIndex)

Returns if element is event based gateway

Parameters:

vertex - element index from process graph

isParallel

boolean isParallel(Integer verticeIndex)

Returns if element is parallel gateway

Parameters:

verticeIndex - element index from process graph

isOR

boolean isOR(Integer verticeIndex)

Returns if element is an OR gateway

Parameters:

verticeIndex - index of an element

isTask

boolean isTask(String name)

Returns if element is a task

Parameters:

name - name of the task

Returns:

isSubProcess

boolean isSubProcess(Integer verticeIndex)

Returns if element is a sub-process

Parameters:

verticeIndex - index of element

Returns:

getAllResources

List<Resource> getAllResources()
                        throws ProcessValidationException

Returns all available resources.

Returns:

List of Resource objects

Throws:

ProcessValidationException - if exception occurs during resource parsing

getArrivalRateDistributionInfo

DistributionInfo getArrivalRateDistributionInfo()

Gets distribution information for arrival rate.

Returns:

Arrival rate DistributionInfo

getEdgeProbability

double getEdgeProbability(String edgeId)
                   throws ProcessValidationException

Returns branching probability for an edge

Parameters:

edgeId - edge id from the mode

Returns:

branching probability [0..1]

Throws:

ProcessValidationException

getElementDurationInformation

DistributionInfo getElementDurationInformation(String elementId)

Returns duration info for element in the process model

Parameters:

activityId - element identifier in the process model

Returns:

element duration information

getTaskResourceId

String getTaskResourceId(String activityId)

Returns resource name for the activity

Parameters:

activityId - activity id from the process model

Returns:

resource name (id)

getTotalProcessInstances

int getTotalProcessInstances()

Returns total number of process instances to create

Returns:

total number of process instances

getStartTime

Date getStartTime()
           throws ProcessValidationException

Returns the start timestamp for simulation.

Returns:

start timestamp in seconds

Throws:

ProcessValidationException

getArrivalRateTimeTable

TimeTable getArrivalRateTimeTable()
                           throws ProcessValidationException

Return timetable with conditions in which time range process instances are created

Returns:

TimeTable used to set start timestamps for start events

Throws:

ProcessValidationException

getElementFixedCost

double getElementFixedCost(String elementId)

Return fixed (constant) cost for executing element

Parameters:

elementId - id of the element in the process model

Returns:

cost of executing the element

getElementCostThreshold

double getElementCostThreshold(String elementId)

Return cost threshold for element. If actual duration is over threshold then it will be reported by KpiCalculator.

Parameters:

elementId - id of the element in the process model

Returns:

cost threshold value, -1 if not defined

getElementDurationThreshold

double getElementDurationThreshold(String elementId)

Return duration threshold for element in seconds. If actual duration is over threshold then it will be reported by KpiCalculator

Parameters:

elementId - id of the element in the process model

Returns:

cost threshold value, -1 if not defined

parse

void parse()
    throws ModelParseException,
           ProcessValidationException

Parse the model

Throws:

ProcessValidationException

ModelParseException

isApplicable

boolean isApplicable()

Detect if parser can be applied to the BP model and contains parser specific simulation info

Returns:

true if parser can be used for the

setInputStreams

void setInputStreams(List<InputStream> inputStreams)

Set input streams to parse

Parameters:

inputStreams - list of input streams to parse

setFiles

void setFiles(List<String> fileNames)

Set input file names to parse

Parameters:

fileNames - list of file names to parse

getFirstProcessInstanceForStats

int getFirstProcessInstanceForStats()

First process instance to start calculating statistics from (included).

Returns:

process instance number

getLastProcessInstanceForStats

int getLastProcessInstanceForStats()

Last process instance to calculate statistics from (excluded).

Returns:

process instance number