BpmnScanner (viadee Process Application Validator 3.0.2 API)

java.lang.Object
- de.viadee.bpm.vPAV.BpmnScanner

```
public class BpmnScanner
extends Object
```

Constructor Summary

Constructors
Constructor and Description
`BpmnScanner(String path)` The Camunda API's method "getImplementation" doesn't return the correct Implementation, so the we have to scan the xml of the model for the implementation

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`checkNamingOfEdges(String id)` check xor gateways for outgoing edges
`boolean`	`checkStartEvent(String id)` Retrieve startevents to check whether any parent node is a subprocess
`String`	`getErrorCodeVar(String id)` get errorCodeVariable
`Map<String,String>`	`getErrorDef(String id)` get errorDefinition
`Map<String,String>`	`getErrorEvent(String id)` get errorEventDefinition
`String`	`getErrorEventMapping(String id)`
`String`	`getEventImplementation(String id)` Return the Implementation of an specific element (endEvent and/or intermediateThrowEvent)
`ArrayList<String>`	`getFieldInjectionExpression(String id)` get value of expression
`ArrayList<String>`	`getFieldInjectionVarName(String id)` get names of variable in fieldInjection
`String`	`getImplementation(String id)` Return the Implementation of an specific element (sendTask, ServiceTask or BusinessRuleTask)
`String`	`getImplementationReference(String id, String implementation)`
`HashMap<String,Map<String,String>>`	`getInputMapping(String id)` get mapping of inputParameters
`Map<String,String>`	`getKeyPairs(String id)`
`ArrayList<String>`	`getLinkRefs(String id)`
`ArrayList<String>`	`getListener(String id, String listType, String extType)`
`org.apache.commons.collections4.map.LinkedMap<String,String>`	`getMappingType(String id, String mapping)` get mapping type for input/output parameters for given element by id
`String`	`getMessageName(String messageRef)` Retrieve the message name
`ArrayList<String>`	`getMessageRefs(String id)`
`int`	`getOutgoing(String id)` Return number of outgoing
`ArrayList<Node>`	`getOutgoingEdges(String id)` check xor gateways for outgoing edges
`HashMap<String,Map<String,String>>`	`getOutputMapping(String id)` get mapping of outputParameters
`ArrayList<String>`	`getScriptTypes(String id)` Check if model has an scriptTag
`ArrayList<String>`	`getSequenceFlowDef(String id)` get sequenceFlow attributes such as sourceRef and targetRef
`String`	`getSignalName(String signalRef)` Retrieve the signal name
`ArrayList<String>`	`getSignalRefs(String id)`
`Map<Element,Element>`	`getTimerImplementation(String id)` get ids and timer definition for all timer event types
`String`	`getXorGateWays(String id)` Return a list of used gateways for a given bpmn model
`boolean`	`hasScriptInCondExp(String id)` Checks for scripts in conditional expressions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BpmnScanner
```
public BpmnScanner(String path)
```
    The Camunda API's method "getImplementation" doesn't return the correct Implementation, so the we have to scan the xml of the model for the implementation
    
    Parameters:
    
    path - path to model
- Method Detail
  - getImplementation
```
public String getImplementation(String id)
```
    Return the Implementation of an specific element (sendTask, ServiceTask or BusinessRuleTask)
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    return_implementation contains implementation
  - getImplementationReference
```
public String getImplementationReference(String id,
                                         String implementation)
```
    Parameters:
    
    id - id of bpmnElement
    
    implementation - DelegateExpression/Java Class
    
    Returns:
    
    implementationReference
  - getEventImplementation
```
public String getEventImplementation(String id)
```
    Return the Implementation of an specific element (endEvent and/or intermediateThrowEvent)
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    return_implementation contains implementation
  - getListener
```
public ArrayList<String> getListener(String id,
                                     String listType,
                                     String extType)
```
    Parameters:
    
    id - id of bpmn element
    
    listType - Type of Attribute
    
    extType - Type of Listener
    
    Returns:
    
    value of Listener
  - getScriptTypes
```
public ArrayList<String> getScriptTypes(String id)
```
    Check if model has an scriptTag
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    scriptPlaces contains script type
  - checkStartEvent
```
public boolean checkStartEvent(String id)
```
    Retrieve startevents to check whether any parent node is a subprocess
    
    Parameters:
    
    id - id of element to check
    
    Returns:
    
    true if id was found
  - hasScriptInCondExp
```
public boolean hasScriptInCondExp(String id)
```
    Checks for scripts in conditional expressions
    
    Parameters:
    
    id - id of the element
    
    Returns:
    
    boolean has condition Expression
  - getXorGateWays
```
public String getXorGateWays(String id)
```
    Return a list of used gateways for a given bpmn model
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    gateway contains script type
  - getOutgoing
```
public int getOutgoing(String id)
```
    Return number of outgoing
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    outgoing number of outgoing
  - getSequenceFlowDef
```
public ArrayList<String> getSequenceFlowDef(String id)
```
    get sequenceFlow attributes such as sourceRef and targetRef
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    ArrayList of outgoing Nodes
  - getOutgoingEdges
```
public ArrayList<Node> getOutgoingEdges(String id)
```
    check xor gateways for outgoing edges
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    ArrayList of outgoing Nodes
  - checkNamingOfEdges
```
public Node checkNamingOfEdges(String id)
```
    check xor gateways for outgoing edges
    
    Parameters:
    
    id - id of edge
    
    Returns:
    
    edge
  - getTimerImplementation
```
public Map<Element,Element> getTimerImplementation(String id)
```
    get ids and timer definition for all timer event types
    
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    Map with timerEventDefinition-Node and his child
  - getMappingType
```
public org.apache.commons.collections4.map.LinkedMap<String,String> getMappingType(String id,
                                                                                   String mapping)
```
    get mapping type for input/output parameters for given element by id
    
    Parameters:
    
    id - id of current element
    
    mapping - input or output mapping
    
    Returns:
    
    mapping type
  - getInputMapping
```
public HashMap<String,Map<String,String>> getInputMapping(String id)
```
    get mapping of inputParameters
    
    Parameters:
    
    id - element id
    
    Returns:
    
    HashMap with mapped variables and values
  - getOutputMapping
```
public HashMap<String,Map<String,String>> getOutputMapping(String id)
```
    get mapping of outputParameters
    
    Parameters:
    
    id - element id
    
    Returns:
    
    HashMap with mapped variables and values
  - getFieldInjectionExpression
```
public ArrayList<String> getFieldInjectionExpression(String id)
```
    get value of expression
    
    Parameters:
    
    id - id from element
    
    Returns:
    
    value of expression
  - getFieldInjectionVarName
```
public ArrayList<String> getFieldInjectionVarName(String id)
```
    get names of variable in fieldInjection
    
    Parameters:
    
    id - id from element
    
    Returns:
    
    names of variable
  - getErrorEvent
```
public Map<String,String> getErrorEvent(String id)
```
    get errorEventDefinition
    
    Parameters:
    
    id - id from element
    
    Returns:
    
    errorEvent
  - getErrorDef
```
public Map<String,String> getErrorDef(String id)
```
    get errorDefinition
    
    Parameters:
    
    id - id from element
    
    Returns:
    
    Map with errorName and errorCode
  - getErrorCodeVar
```
public String getErrorCodeVar(String id)
```
    get errorCodeVariable
    
    Parameters:
    
    id - id from element
    
    Returns:
    
    String with errorCodeVariable
  - getErrorEventMapping
```
public String getErrorEventMapping(String id)
```
    Parameters:
    
    id - id of boundaryErrorEvent
    
    Returns:
    
    attachedToTask
  - getKeyPairs
```
public Map<String,String> getKeyPairs(String id)
```
    Parameters:
    
    id - id of bpmn element
    
    Returns:
    
    map with key value pair of given element
  - getLinkRefs
```
public ArrayList<String> getLinkRefs(String id)
```
  - getSignalRefs
```
public ArrayList<String> getSignalRefs(String id)
```
  - getMessageRefs
```
public ArrayList<String> getMessageRefs(String id)
```
  - getMessageName
```
public String getMessageName(String messageRef)
```
    Retrieve the message name
    
    Parameters:
    
    messageRef - id of message
    
    Returns:
    
    messageName
  - getSignalName
```
public String getSignalName(String signalRef)
```
    Retrieve the signal name
    
    Parameters:
    
    signalRef - id of signal
    
    Returns:
    
    signalName

Class BpmnScanner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BpmnScanner

Method Detail

getImplementation

getImplementationReference

getEventImplementation

getListener

getScriptTypes

checkStartEvent

hasScriptInCondExp

getXorGateWays

getOutgoing

getSequenceFlowDef

getOutgoingEdges

checkNamingOfEdges

getTimerImplementation

getMappingType

getInputMapping

getOutputMapping

getFieldInjectionExpression

getFieldInjectionVarName

getErrorEvent

getErrorDef

getErrorCodeVar

getErrorEventMapping

getKeyPairs

getLinkRefs

getSignalRefs

getMessageRefs

getMessageName

getSignalName