|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.processmining.framework.log.LogReader
public abstract class LogReader
Interface for log reading and modification access to process event logs.
Constructor Summary | |
---|---|
LogReader()
|
Method Summary | |
---|---|
abstract LogReader |
clone(int[] pitk)
Clones this log reader, including all contained processes and process instances. |
static LogReader |
createInstance(LogFilter filter,
LogFile file)
Factory method prototype. |
static LogReader |
createInstance(LogReader reader,
int[] processInstancesToKeep)
Factory method prototype. |
static LogReader |
createInstance(LogReader reader,
LogFilter filter)
Factory method prototype. |
abstract LogFile |
getFile()
Returns the log file instance that was given in the constructor. |
abstract ProcessInstance |
getInstance(int index)
Retrieves the process instance located at the given index within the encapsulated log file. |
java.util.List<ProcessInstance> |
getInstances()
|
abstract LogFilter |
getLogFilter()
Returns the filter instance that was given in the constructor. |
abstract LogSummary |
getLogSummary()
Returns a LogSummary object with summarized info about the
workflow log. |
abstract Process |
getProcess(int index)
Retrieves the process located at the given index within the encapsulated log file. |
abstract boolean |
hasNext()
Deprecated. If you prefer to use iterator access to process instances, use the instanceIterator() method instead! |
abstract java.util.Iterator |
instanceIterator()
Retrieves an iterator over the process instances contained in the encapsulated log file. |
abstract boolean |
isSelection()
Tells whether or not this logReader object represents a selection of a log, instead of a complete log. |
abstract ProcessInstance |
next()
Deprecated. If you prefer to use iterator access to process instances, use the instanceIterator() method instead! |
abstract int |
numberOfInstances()
Retrieves the number of process instances contained in this log file. |
abstract int |
numberOfProcesses()
Retrieves the number of processes contained in this log file. |
abstract int[] |
processInstancesToKeep()
Retrieves the indices of process instances which are not excluded from reading. |
abstract java.util.Iterator |
processIterator()
Retrieves an iterator over the processes contained in the encapsulated log file. |
abstract void |
reset()
Deprecated. If you prefer to use iterator access to process instances, use the instanceIterator() method instead! |
abstract java.lang.String |
toString()
Returns a string representation of this log reader instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LogReader()
Method Detail |
---|
public static LogReader createInstance(LogReader reader, LogFilter filter) throws java.lang.Exception
Notice: You have to override this method in your log reader implementation, as instances will always be created using a static factory method within ProM.
reader
- A log reader on whose log the new log reader is based.filter
- The LogFilter to use for the created log reader.
java.lang.Exception
public static LogReader createInstance(LogFilter filter, LogFile file) throws java.lang.Exception
Notice: You have to override this method in your log reader implementation, as instances will always be created using a static factory method within ProM.
filter
- The LogFilter to use for the created log reader.file
- The file to back the created log reader.
java.lang.Exception
public static LogReader createInstance(LogReader reader, int[] processInstancesToKeep) throws java.lang.Exception
Notice: You have to override this method in your log reader implementation, as instances will always be created using a static factory method within ProM.
reader
- The log reader from which the newly created instance inherits
its setting and configuration (filter, file, etc.).processInstancesToKeep
- Indices of the process instances, which are to be contained in
the newly created log reader.
java.lang.Exception
public abstract LogReader clone(int[] pitk)
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.
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.
public abstract java.lang.String toString()
toString
in class java.lang.Object
public abstract boolean isSelection()
public abstract LogFile getFile()
public abstract LogFilter getLogFilter()
public abstract LogSummary getLogSummary()
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.
LogSummary
object with summarized info about the
workflow logpublic abstract int[] processInstancesToKeep()
public abstract java.util.Iterator instanceIterator()
public java.util.List<ProcessInstance> getInstances()
public abstract int numberOfInstances()
public abstract ProcessInstance getInstance(int index)
index
- index of the requested process instance in the log
public abstract java.util.Iterator processIterator()
public abstract int numberOfProcesses()
public abstract Process getProcess(int index)
index
- index of the requested process in the log
public abstract boolean hasNext()
instanceIterator()
method instead!
Probes whether the log reader has another process instance available for reading.
public abstract ProcessInstance next()
instanceIterator()
method instead!
Retrieves the next process instance from the log.
public abstract void reset()
instanceIterator()
method instead!
Resets the main iterator to the first process instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |