org.processmining.framework.log
Class Process

java.lang.Object
  extended by org.processmining.framework.log.LogEntity
      extended by org.processmining.framework.log.Process
Direct Known Subclasses:
ProcessImpl, ProxyProcess

public abstract class Process
extends LogEntity

This abstract class provides high-level access and information for a process, including access to the contained process instances.

Author:
Christian W. Guenther(christian at deckfour dot org)

Constructor Summary
Process()
           
 
Method Summary
abstract  void addProcessInstance(ProcessInstance instance)
          Adds the given process instance to this process.
abstract  int clear()
          Removes all contained process instances from this process.
abstract  ProcessInstance getInstance(int index)
          Retrieves an instance of this process by its relative index, i.e.
abstract  ProcessInstance getInstance(java.lang.String name)
          Retrieves an instance of this process identified by its name, or ID, string.
abstract  java.lang.String[] getInstanceNames()
          Returns an array containing the names, or IDs, of all instances of this process.
abstract  ModelElements getModelElements()
          Returns the set of model elements contained in all instances of this process.
abstract  java.util.Iterator iterator()
          Returns an iterator over all instances of this process in the log.
abstract  ProcessInstance removeProcessInstance(int index)
          Removes the process instance with the given index, i.e.
abstract  ProcessInstance removeProcessInstance(java.lang.String name)
          Removes the process instance with the given name, or ID, from this process.
abstract  int size()
          Returns the number of instances for this process contained in the log.
 
Methods inherited from class org.processmining.framework.log.LogEntity
getAttributes, getDescription, getName, removeAttribute, setAttribute, setAttributes, setDescription, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Process

public Process()
Method Detail

size

public abstract int size()
Returns the number of instances for this process contained in the log.

Returns:

getInstance

public abstract ProcessInstance getInstance(int index)
Retrieves an instance of this process by its relative index, i.e. order of appearance in the log.

Parameters:
index - Index of the requested process instance, must be within the range [0, size()].
Returns:

getInstanceNames

public abstract java.lang.String[] getInstanceNames()
Returns an array containing the names, or IDs, of all instances of this process.

Returns:

getInstance

public abstract ProcessInstance getInstance(java.lang.String name)
Retrieves an instance of this process identified by its name, or ID, string.

Parameters:
name -
Returns:

iterator

public abstract java.util.Iterator iterator()
Returns an iterator over all instances of this process in the log.

Returns:

addProcessInstance

public abstract void addProcessInstance(ProcessInstance instance)
Adds the given process instance to this process. The process defined in the given instance must correspond to this process. If an instance with the same name is already contained in this process, it will be replaced by the given one.

Parameters:
instance -

removeProcessInstance

public abstract ProcessInstance removeProcessInstance(java.lang.String name)
Removes the process instance with the given name, or ID, from this process.

Parameters:
name - Name of the process instance to remove.
Returns:
The instance, if it was contained and removed; null otherwise.

removeProcessInstance

public abstract ProcessInstance removeProcessInstance(int index)
Removes the process instance with the given index, i.e. order in the log, from this process.

Parameters:
index - Index of the process instance to remove.
Returns:
The instance, if it was contained and removed; null otherwise.

clear

public abstract int clear()
Removes all contained process instances from this process.

Returns:
The number of removed process instances.

getModelElements

public abstract ModelElements getModelElements()
Returns the set of model elements contained in all instances of this process.

Returns: