org.processmining.framework.log.proxy
Class ProxyLogReader

java.lang.Object
  extended by org.processmining.framework.log.LogReader
      extended by org.processmining.framework.log.proxy.ProxyLogReader

public class ProxyLogReader
extends LogReader

Author:
Christian W. Guenther (christian@deckfour.org)

Nested Class Summary
protected  class ProxyLogReader.ProxyProcessInstanceIterator
           
protected  class ProxyLogReader.ProxyProcessIterator
           
 
Field Summary
protected  LogReader parent
           
 
Constructor Summary
ProxyLogReader(LogReader reader)
           
 
Method Summary
 LogReader clone(int[] pitk)
          Clones this log reader, including all contained processes and process instances.
 LogFile getFile()
          Returns the log file instance that was given in the constructor.
 ProcessInstance getInstance(int index)
          Retrieves the process instance located at the given index within the encapsulated log file.
 LogFilter getLogFilter()
          Returns the filter instance that was given in the constructor.
 LogSummary getLogSummary()
          Returns a LogSummary object with summarized info about the workflow log.
 Process getProcess(int index)
          Retrieves the process located at the given index within the encapsulated log file.
 boolean hasNext()
          Iterator interface method.
 java.util.Iterator instanceIterator()
          Retrieves an iterator over the process instances contained in the encapsulated log file.
 boolean isSelection()
          Tells whether or not this logReader object represents a selection of a log, instead of a complete log.
 ProcessInstance next()
          Iterator interface method.
 int numberOfInstances()
          Retrieves the number of process instances contained in this log file.
 int numberOfProcesses()
          Retrieves the number of processes contained in this log file.
 int[] processInstancesToKeep()
          Retrieves the indices of process instances which are not excluded from reading.
 java.util.Iterator processIterator()
          Retrieves an iterator over the processes contained in the encapsulated log file.
 void reset()
          Iterator interface method.
 java.lang.String toString()
          Returns a string representation of this log reader instance.
 
Methods inherited from class org.processmining.framework.log.LogReader
createInstance, createInstance, createInstance, getInstances
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

parent

protected LogReader parent
Constructor Detail

ProxyLogReader

public ProxyLogReader(LogReader reader)
Method Detail

clone

public LogReader clone(int[] pitk)
Description copied from class: LogReader
Clones this log reader, including all contained processes and process instances. The contained process instances, whose indices are contained in the given integer array, are excluded and will not be contained in the returned clone.

Notice that this method will yield a deep copy of the cloned instance. This implies doubling this instance's memory consumption (either in random access memory or filesystem space consumption, depending on the implementation) and no synchronization of changes between original and clone.

Specified by:
clone in class LogReader
Parameters:
pitk - The contained process instances, whose indices are contained in the given integer array, are excluded and will not be contained in the returned clone.
Returns:
A clone of this log reader, excluding the process instances whose indices are given in the supplied array.

getFile

public LogFile getFile()
Description copied from class: LogReader
Returns the log file instance that was given in the constructor.

Specified by:
getFile in class LogReader
Returns:
the log file instance that was given in the constructor

getInstance

public ProcessInstance getInstance(int index)
Description copied from class: LogReader
Retrieves the process instance located at the given index within the encapsulated log file.

Specified by:
getInstance in class LogReader
Parameters:
index - index of the requested process instance in the log
Returns:
referenced process instance.

getLogFilter

public LogFilter getLogFilter()
Description copied from class: LogReader
Returns the filter instance that was given in the constructor.

Specified by:
getLogFilter in class LogReader
Returns:
the filter instance that was given in the constructor

getLogSummary

public LogSummary getLogSummary()
Description copied from class: LogReader
Returns a LogSummary object with summarized info about the workflow log. Note that, if a filter is used, any information provided in this object is based on the filtered log, not on the real contents of the log file.

Specified by:
getLogSummary in class LogReader
Returns:
a LogSummary object with summarized info about the workflow log

getProcess

public Process getProcess(int index)
Description copied from class: LogReader
Retrieves the process located at the given index within the encapsulated log file.

Specified by:
getProcess in class LogReader
Parameters:
index - index of the requested process in the log
Returns:
referenced process.

hasNext

public boolean hasNext()
Description copied from class: LogReader
Iterator interface method.

Probes whether the log reader has another process instance available for reading.

Specified by:
hasNext in class LogReader
Returns:

instanceIterator

public java.util.Iterator instanceIterator()
Description copied from class: LogReader
Retrieves an iterator over the process instances contained in the encapsulated log file.

Specified by:
instanceIterator in class LogReader
Returns:
an iterator over the contained process instances.

isSelection

public boolean isSelection()
Description copied from class: LogReader
Tells whether or not this logReader object represents a selection of a log, instead of a complete log.

Specified by:
isSelection in class LogReader
Returns:
true if it it a selection

next

public ProcessInstance next()
Description copied from class: LogReader
Iterator interface method.

Retrieves the next process instance from the log.

Specified by:
next in class LogReader
Returns:
The next process instance from the log.

numberOfInstances

public int numberOfInstances()
Description copied from class: LogReader
Retrieves the number of process instances contained in this log file.

Specified by:
numberOfInstances in class LogReader
Returns:
the number of process instances contained in this log file.

numberOfProcesses

public int numberOfProcesses()
Description copied from class: LogReader
Retrieves the number of processes contained in this log file.

Specified by:
numberOfProcesses in class LogReader
Returns:
the number of processes contained in this log file.

processInstancesToKeep

public int[] processInstancesToKeep()
Description copied from class: LogReader
Retrieves the indices of process instances which are not excluded from reading.

Specified by:
processInstancesToKeep in class LogReader
Returns:

processIterator

public java.util.Iterator processIterator()
Description copied from class: LogReader
Retrieves an iterator over the processes contained in the encapsulated log file.

Specified by:
processIterator in class LogReader
Returns:
an iterator over the contained processes.

reset

public void reset()
Description copied from class: LogReader
Iterator interface method.

Resets the main iterator to the first process instance.

Specified by:
reset in class LogReader

toString

public java.lang.String toString()
Description copied from class: LogReader
Returns a string representation of this log reader instance.

Specified by:
toString in class LogReader