org.processmining.framework.log.classic
Class ProcessInstanceClassic

java.lang.Object
  extended by org.processmining.framework.log.LogEntity
      extended by org.processmining.framework.log.ProcessInstance
          extended by org.processmining.framework.log.classic.ProcessInstanceClassic

public class ProcessInstanceClassic
extends ProcessInstance

A single process instance.

Version:
1.0
Author:
Peter van den Brand

Field Summary
protected  java.util.HashMap<java.lang.String,java.lang.String> attributes
           
protected  java.lang.String description
           
protected  java.lang.String name
           
 
Fields inherited from class org.processmining.framework.log.ProcessInstance
ATT_ATE_ID, ATT_ATE_POST, ATT_ATE_PRE, ATT_PI_PO
 
Constructor Summary
ProcessInstanceClassic(java.lang.String process, java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,java.lang.String> data, java.util.ArrayList entries)
           
 
Method Summary
 ProcessInstance cloneInstance()
          Returns a deep copy of this process instance.
 java.util.Map<java.lang.String,java.lang.String> getAttributes()
          Returns the meta-data, as map of key-value pairs, associated to this entity.
 AuditTrailEntries getAuditTrailEntries()
          Returns the sequential set of audit trail entries, as found in this process instance.
 AuditTrailEntryList getAuditTrailEntryList()
          Returns the sequential set of audit trail entries, as found in this process instance.
 java.util.Map getData()
          This method is deprecated! Use getAttributes() instead!
 java.lang.String getDescription()
          Returns the description of this entity.
 ModelElements getModelElements()
          Returns the set of model elements contained in this process instance.
 java.lang.String getName()
          Returns the name of this entity.
 java.lang.String getProcess()
          Returns the identifier / name of the process of this object is an instance.
 boolean isEmpty()
          Returns true, if this process instance contains no audit trail entries to read.
 void removeAttribute(java.lang.String key)
          Removes the attribute with the given key from the set of attributes of this entity.
 void setAttribute(java.lang.String key, java.lang.String value)
          Sets an attribute of this entity as a key-value pair.
 void setAttributes(java.util.Map<java.lang.String,java.lang.String> data)
          Sets the set of attributes, given as key-value pairs, for this entity.
 void setDescription(java.lang.String nDescription)
          Sets the description of this entity
 void setName(java.lang.String nName)
          Sets the name, or ID, of this entity
 java.lang.String toString()
          Returns a string representation of this entity.
 
Methods inherited from class org.processmining.framework.log.ProcessInstance
getListOfATEs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

description

protected java.lang.String description

attributes

protected java.util.HashMap<java.lang.String,java.lang.String> attributes
Constructor Detail

ProcessInstanceClassic

public ProcessInstanceClassic(java.lang.String process,
                              java.lang.String name,
                              java.lang.String description,
                              java.util.Map<java.lang.String,java.lang.String> data,
                              java.util.ArrayList entries)
Method Detail

getDescription

public java.lang.String getDescription()
Description copied from class: LogEntity
Returns the description of this entity.

Specified by:
getDescription in class LogEntity
Returns:

getProcess

public java.lang.String getProcess()
Description copied from class: ProcessInstance
Returns the identifier / name of the process of this object is an instance.

Specified by:
getProcess in class ProcessInstance
Returns:

getName

public java.lang.String getName()
Description copied from class: LogEntity
Returns the name of this entity.

Specified by:
getName in class LogEntity
Returns:

isEmpty

public boolean isEmpty()
Description copied from class: ProcessInstance
Returns true, if this process instance contains no audit trail entries to read.

Specified by:
isEmpty in class ProcessInstance
Returns:

getAuditTrailEntries

public AuditTrailEntries getAuditTrailEntries()
Description copied from class: ProcessInstance
Returns the sequential set of audit trail entries, as found in this process instance.

Specified by:
getAuditTrailEntries in class ProcessInstance
Returns:

getModelElements

public ModelElements getModelElements()
Description copied from class: ProcessInstance
Returns the set of model elements contained in this process instance.

Specified by:
getModelElements in class ProcessInstance
Returns:

getData

public java.util.Map getData()
Description copied from class: ProcessInstance
This method is deprecated! Use getAttributes() instead!

Overrides:
getData in class ProcessInstance
Returns:

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()
Description copied from class: LogEntity
Returns the meta-data, as map of key-value pairs, associated to this entity.

Specified by:
getAttributes in class LogEntity
Returns:

toString

public java.lang.String toString()
Description copied from class: LogEntity
Returns a string representation of this entity.

Specified by:
toString in class LogEntity

getAuditTrailEntryList

public AuditTrailEntryList getAuditTrailEntryList()
Description copied from class: ProcessInstance
Returns the sequential set of audit trail entries, as found in this process instance.

Specified by:
getAuditTrailEntryList in class ProcessInstance
Returns:

cloneInstance

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

Specified by:
cloneInstance in class ProcessInstance
Returns:
A deep copy of this process instance.

removeAttribute

public void removeAttribute(java.lang.String key)
Description copied from class: LogEntity
Removes the attribute with the given key from the set of attributes of this entity.

Specified by:
removeAttribute in class LogEntity

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.String value)
Description copied from class: LogEntity
Sets an attribute of this entity as a key-value pair. If a previous mapping for the given key exists, it will be removed. Otherwise a new mapping will be added.

Specified by:
setAttribute in class LogEntity

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> data)
Description copied from class: LogEntity
Sets the set of attributes, given as key-value pairs, for this entity. Replaces the previously contained set of attributes.

Specified by:
setAttributes in class LogEntity

setDescription

public void setDescription(java.lang.String nDescription)
Description copied from class: LogEntity
Sets the description of this entity

Specified by:
setDescription in class LogEntity

setName

public void setName(java.lang.String nName)
Description copied from class: LogEntity
Sets the name, or ID, of this entity

Specified by:
setName in class LogEntity