org.processmining.framework.log
Class LogEntity

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

public abstract class LogEntity
extends java.lang.Object

This abstract class contains the basic attributes of any log entity, such as and audit trail entry, process, or process instance, and corresponding retrieval and modification methods.

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

Constructor Summary
LogEntity()
           
 
Method Summary
abstract  java.util.Map<java.lang.String,java.lang.String> getAttributes()
          Returns the meta-data, as map of key-value pairs, associated to this entity.
abstract  java.lang.String getDescription()
          Returns the description of this entity.
abstract  java.lang.String getName()
          Returns the name of this entity.
abstract  void removeAttribute(java.lang.String key)
          Removes the attribute with the given key from the set of attributes of this entity.
abstract  void setAttribute(java.lang.String key, java.lang.String value)
          Sets an attribute of this entity as a key-value pair.
abstract  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.
abstract  void setDescription(java.lang.String description)
          Sets the description of this entity
abstract  void setName(java.lang.String name)
          Sets the name, or ID, of this entity
abstract  java.lang.String toString()
          Returns a string representation of this entity.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LogEntity

public LogEntity()
Method Detail

getName

public abstract java.lang.String getName()
Returns the name of this entity.

Returns:

getDescription

public abstract java.lang.String getDescription()
Returns the description of this entity.

Returns:

getAttributes

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

Returns:

setName

public abstract void setName(java.lang.String name)
Sets the name, or ID, of this entity

Parameters:
name -

setDescription

public abstract void setDescription(java.lang.String description)
Sets the description of this entity

Parameters:
description -

setAttributes

public abstract 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. Replaces the previously contained set of attributes.

Parameters:
data -

setAttribute

public abstract void setAttribute(java.lang.String key,
                                  java.lang.String value)
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.

Parameters:
key -
value -

removeAttribute

public abstract void removeAttribute(java.lang.String key)
Removes the attribute with the given key from the set of attributes of this entity.

Parameters:
key -

toString

public abstract java.lang.String toString()
Returns a string representation of this entity.

Overrides:
toString in class java.lang.Object
Returns: