org.processmining.framework.log
Class ProcessInstance

java.lang.Object
  extended by org.processmining.framework.log.LogEntity
      extended by org.processmining.framework.log.ProcessInstance
Direct Known Subclasses:
ProcessInstanceClassic, ProcessInstanceImpl, ProxyProcessInstance

public abstract class ProcessInstance
extends LogEntity

This abstract class provides acces to a process instance as read from a log file

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

Field Summary
static java.lang.String ATT_ATE_ID
          This constant can be used to search the data container of each audit-trail entry for the id of that entry.
static java.lang.String ATT_ATE_POST
          This constant can be used to search the data container of each audit-trail entry for a comma separated list of successor-IDs of the ate.
static java.lang.String ATT_ATE_PRE
          This constant can be used to search the data container of each audit-trail entry for a comma separated list of predecessor-IDs of the ate.
static java.lang.String ATT_PI_PO
          This constant can be used to search the data container of the process instance to see whether or not it describes a partial order.
 
Constructor Summary
ProcessInstance()
           
 
Method Summary
abstract  ProcessInstance cloneInstance()
          Returns a deep copy of this process instance.
abstract  AuditTrailEntries getAuditTrailEntries()
          Deprecated. Use the AuditTrailEntryList interface for accessing audit trail entries in a sequential manner instead. This interface also provides support for persistently modifying sets of audit trail entries.
abstract  AuditTrailEntryList getAuditTrailEntryList()
          Returns the sequential set of audit trail entries, as found in this process instance.
 java.util.Map getData()
          Deprecated. Use getAttributes() instead!
 java.util.List<AuditTrailEntry> getListOfATEs()
          Returns the sequential list of audit trail entries, as found in this process instance.
abstract  ModelElements getModelElements()
          Returns the set of model elements contained in this process instance.
abstract  java.lang.String getProcess()
          Returns the identifier / name of the process of this object is an instance.
abstract  boolean isEmpty()
          Returns true, if this process instance contains no audit trail entries to read.
 
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
 

Field Detail

ATT_PI_PO

public static final java.lang.String ATT_PI_PO
This constant can be used to search the data container of the process instance to see whether or not it describes a partial order. If it does descibe a partial order, this attribute should be mapped to "true" and each audit trail entry should have an id according to ATT_ATE_ID. It is a preliminary solution for storing process instances as partial orders.

See Also:
Constant Field Values

ATT_ATE_ID

public static final java.lang.String ATT_ATE_ID
This constant can be used to search the data container of each audit-trail entry for the id of that entry. The result is a string. It is a preliminary solution for storing process instances as partial orders.

See Also:
Constant Field Values

ATT_ATE_POST

public static final java.lang.String ATT_ATE_POST
This constant can be used to search the data container of each audit-trail entry for a comma separated list of successor-IDs of the ate. It is a preliminary solution for storing process instances as partial orders.

See Also:
Constant Field Values

ATT_ATE_PRE

public static final java.lang.String ATT_ATE_PRE
This constant can be used to search the data container of each audit-trail entry for a comma separated list of predecessor-IDs of the ate. It is a preliminary solution for storing process instances as partial orders.

See Also:
Constant Field Values
Constructor Detail

ProcessInstance

public ProcessInstance()
Method Detail

getProcess

public abstract java.lang.String getProcess()
Returns the identifier / name of the process of this object is an instance.

Returns:

isEmpty

public abstract boolean isEmpty()
Returns true, if this process instance contains no audit trail entries to read.

Returns:

getAuditTrailEntryList

public abstract AuditTrailEntryList getAuditTrailEntryList()
Returns the sequential set of audit trail entries, as found in this process instance.

Returns:

getListOfATEs

public java.util.List<AuditTrailEntry> getListOfATEs()
Returns the sequential list of audit trail entries, as found in this process instance.

Returns:

getModelElements

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

Returns:

cloneInstance

public abstract ProcessInstance cloneInstance()
Returns a deep copy of this process instance. Modifications are defined to be not synchronized between original and returned clone.

Returns:
A deep copy of this process instance.

getData

public java.util.Map getData()
Deprecated. Use getAttributes() instead!

This method is deprecated! Use getAttributes() instead!

Returns:

getAuditTrailEntries

public abstract AuditTrailEntries getAuditTrailEntries()
Deprecated. Use the AuditTrailEntryList interface for accessing audit trail entries in a sequential manner instead. This interface also provides support for persistently modifying sets of audit trail entries.

Returns the sequential set of audit trail entries, as found in this process instance.

Returns: