org.processmining.analysis.performance.dottedchart.logutil
Class LogUnitList

java.lang.Object
  extended by org.processmining.analysis.performance.dottedchart.logutil.LogUnitList

public class LogUnitList
extends java.lang.Object

This class represents a Data Modification Cluster (LogUnitList). Data modification clusters extracted in the initial scan pass.

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

Field Summary
protected  java.util.Date endRelativeDate
           
protected  java.util.ArrayList<AbstractLogUnit> events
           
protected static long id_counter
          static counter value for providing unique id numbers
protected  long id_nr
           
protected  java.lang.String id_string
           
protected  java.util.Date startRelativeDate
           
 
Constructor Summary
LogUnitList()
          creates a new LogUnitList object
LogUnitList(java.lang.String id)
          constructor
 
Method Summary
 void addEvent(AbstractLogUnit entry)
          Adds a new event to this LogUnitList
 int compareTo(java.lang.Object arg0)
           
 boolean containsEvent(AbstractLogUnit entry)
          deep check whether a given AbstractLogUnit is contained within this LogUnitList's event set
 boolean equals(java.lang.Object obj)
          tests with equality to another LogUnitList WARNING: As 'AuditTrailEntry' does so far not override the 'equals()' method this method does, as well, not check for real value equality.
 java.util.ArrayList<AbstractLogUnit> getEvents()
           
 long getIdNumber()
           
 java.lang.String getIdString()
           
 java.util.Date getLeftBoundaryTimestamp(java.util.ArrayList<java.lang.String> eventTypeToKeep, java.util.ArrayList instanceIDs)
           
 java.util.Date getRightBoundaryTimestamp(java.util.ArrayList<java.lang.String> eventTypeToKeep, java.util.ArrayList instanceIDs)
           
 java.util.Iterator<AbstractLogUnit> iterator()
           
protected static long nextId()
          Static facility to provide unique, ascending id numbers
static void resetIdCounter()
          manually resets the static id counter to zero
 void resetPositionOfItems()
           
 int size()
           
 int size(java.util.ArrayList<java.lang.String> eventTypeToKeep, java.util.ArrayList instanceIDs)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id_counter

protected static long id_counter
static counter value for providing unique id numbers


events

protected java.util.ArrayList<AbstractLogUnit> events

startRelativeDate

protected java.util.Date startRelativeDate

endRelativeDate

protected java.util.Date endRelativeDate

id_nr

protected long id_nr

id_string

protected java.lang.String id_string
Constructor Detail

LogUnitList

public LogUnitList()
creates a new LogUnitList object


LogUnitList

public LogUnitList(java.lang.String id)
constructor

Parameters:
id - a custom id string
Method Detail

nextId

protected static long nextId()
Static facility to provide unique, ascending id numbers

Returns:
a unique id number

resetIdCounter

public static void resetIdCounter()
manually resets the static id counter to zero


addEvent

public void addEvent(AbstractLogUnit entry)
Adds a new event to this LogUnitList

Parameters:
entry -

getEvents

public java.util.ArrayList<AbstractLogUnit> getEvents()
Returns:
the set of events contained within this LogUnitList

iterator

public java.util.Iterator<AbstractLogUnit> iterator()
Returns:
iterator over LogUnitLists contained

size

public int size()
Returns:
number of events contained

size

public int size(java.util.ArrayList<java.lang.String> eventTypeToKeep,
                java.util.ArrayList instanceIDs)
Returns:
number of events contained

equals

public boolean equals(java.lang.Object obj)
tests with equality to another LogUnitList WARNING: As 'AuditTrailEntry' does so far not override the 'equals()' method this method does, as well, not check for real value equality. This needs, if necessary, to be fixed in AuditTrailEntry.

Overrides:
equals in class java.lang.Object
Parameters:
obj -
Returns:

containsEvent

public boolean containsEvent(AbstractLogUnit entry)
deep check whether a given AbstractLogUnit is contained within this LogUnitList's event set

Parameters:
entry -
Returns:

getLeftBoundaryTimestamp

public java.util.Date getLeftBoundaryTimestamp(java.util.ArrayList<java.lang.String> eventTypeToKeep,
                                               java.util.ArrayList instanceIDs)
Returns:
the timestamp of the leftmost event in this LogUnitList

getRightBoundaryTimestamp

public java.util.Date getRightBoundaryTimestamp(java.util.ArrayList<java.lang.String> eventTypeToKeep,
                                                java.util.ArrayList instanceIDs)
Returns:
the timestamp of the rightmost event in this LogUnitList

resetPositionOfItems

public void resetPositionOfItems()

getIdNumber

public long getIdNumber()
Returns:
the id sequence number of this LogUnitList

getIdString

public java.lang.String getIdString()
Returns:
the id string of this LogUnitList

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
the id string of this LogUnitList

compareTo

public int compareTo(java.lang.Object arg0)