org.processmining.framework.log
Interface LogSummary

All Known Implementing Classes:
ExtendedLogSummary, LightweightLogSummary

public interface LogSummary

A summary of a workflow log.

Version:
1.1
Author:
Peter van den Brand, Christian W. Guenther (christian at deckfour dot org)

Method Summary
 java.util.Map<LogEvent,java.lang.Integer> getEndingLogEvents()
          Returns the mapping between the ending log events and the number of times they end a process instance.
 java.util.Date getEndTime(java.lang.String process)
          Returns the latest timestamp in all audittrailentries of the given process
 java.util.Set<LogEvent> getEventsForInstance(ProcessInstance instance)
          Returns the set of log events occurring in the specified process instance.
 java.util.Map<LogEvent,java.lang.Integer> getEventsForOriginator(java.lang.String originator)
          Returns a Map, whose keys are the events which have been executed by the specified originator.
 java.lang.String[] getEventTypes()
          Returns an alphabetically sorted list of all event types in the log.
 java.util.Set<ProcessInstance> getInstancesForEvent(LogEvent event)
          Returns a set of (references to) process instances, in which the provided log event occurs.
 LogEvents getLogEvents()
          Returns a list of all log events (unique model element name and event type combinations) in the log.
 java.lang.String[] getModelElements()
          Returns an alphabetically sorted list of all model element names in the log.
 int getNumberOfAuditTrailEntries()
          Returns the total number of audit trail entries in the log.
 int getNumberOfProcessInstances()
          Returns the total number of process instances in the log.
 int getNumberOfUniqueProcessInstances()
          Returns the number of different process instances in the log.
 java.lang.String[] getOriginators()
          Returns an alphabetically sorted list of all originators in the log.
 InfoItem[] getProcesses()
          Returns information about all the processes in the log.
 java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>> getProcessInstancesOccurrences()
          Returns the mapping between process instances occurrences and the names of the process instances that occurred a certain amount of times.
 InfoItem getSource()
          Returns information about the source.
 java.util.Map<LogEvent,java.lang.Integer> getStartingLogEvents()
          Returns the mapping between the starting log events and the number of times they start a process instance.
 java.util.Date getStartTime(java.lang.String process)
          Returns the earliest timestamp in all audittrailentries of the given process
 InfoItem getWorkflowLog()
          Returns information about the workflow log itself.
 

Method Detail

getWorkflowLog

InfoItem getWorkflowLog()
Returns information about the workflow log itself. Provides the 'description' attribute of the 'workflow' tag and the contents of the 'data' section.

Returns:
information about the workflow log itself

getSource

InfoItem getSource()
Returns information about the source. Provides 'program' attribute of the 'source' tag and the contents of the 'data' section.

Returns:
information about the source

getProcesses

InfoItem[] getProcesses()
Returns information about all the processes in the log. Provides an array with one entry per process. Each entry contains the 'id' and 'description' attributes of the 'process' tag and the contents of the 'data' section.

Returns:
information about the processes

getStartTime

java.util.Date getStartTime(java.lang.String process)
Returns the earliest timestamp in all audittrailentries of the given process

Parameters:
process - Name of the process
Returns:
Date null in case the log does not contain any timestamp for this process

getEndTime

java.util.Date getEndTime(java.lang.String process)
Returns the latest timestamp in all audittrailentries of the given process

Parameters:
process - Name of the process
Returns:
Date null in case the log does not contain any timestamp for this process

getNumberOfAuditTrailEntries

int getNumberOfAuditTrailEntries()
Returns the total number of audit trail entries in the log.

Returns:
the total number of audit trail entries in the log

getNumberOfProcessInstances

int getNumberOfProcessInstances()
Returns the total number of process instances in the log.

Returns:
the total number of process instances in the log

getNumberOfUniqueProcessInstances

int getNumberOfUniqueProcessInstances()
Returns the number of different process instances in the log.

Returns:
the number different of process instances in the log

getEventTypes

java.lang.String[] getEventTypes()
Returns an alphabetically sorted list of all event types in the log.

Returns:
an alphabetically sorted list of all event types in the log

getModelElements

java.lang.String[] getModelElements()
Returns an alphabetically sorted list of all model element names in the log.

Returns:
an alphabetically sorted list of all model element names in the log

getOriginators

java.lang.String[] getOriginators()
Returns an alphabetically sorted list of all originators in the log.

Returns:
an alphabetically sorted list of all originators in the log

getLogEvents

LogEvents getLogEvents()
Returns a list of all log events (unique model element name and event type combinations) in the log.

Returns:
a list of all log events in the log

getInstancesForEvent

java.util.Set<ProcessInstance> getInstancesForEvent(LogEvent event)
Returns a set of (references to) process instances, in which the provided log event occurs.

Parameters:
event - Log event to find instances for.
Returns:
A set of process instances.

getEventsForInstance

java.util.Set<LogEvent> getEventsForInstance(ProcessInstance instance)
Returns the set of log events occurring in the specified process instance.

Parameters:
instance - Process instance to find log events for.
Returns:
A set of log events.

getEventsForOriginator

java.util.Map<LogEvent,java.lang.Integer> getEventsForOriginator(java.lang.String originator)
Returns a Map, whose keys are the events which have been executed by the specified originator. The values for each key indicate how often the originator has performed the task.

Parameters:
originator - Originator as string.
Returns:
A hashmap with log events executed by the specified originator, and the number of times that the originator performed each event.

getProcessInstancesOccurrences

java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>> getProcessInstancesOccurrences()
Returns the mapping between process instances occurrences and the names of the process instances that occurred a certain amount of times.

Returns:
A mapping between process intance occurrences.

getStartingLogEvents

java.util.Map<LogEvent,java.lang.Integer> getStartingLogEvents()
Returns the mapping between the starting log events and the number of times they start a process instance.

Returns:
A mapping between starting log events occurrence.

getEndingLogEvents

java.util.Map<LogEvent,java.lang.Integer> getEndingLogEvents()
Returns the mapping between the ending log events and the number of times they end a process instance.

Returns:
A mapping between starting log events occurrence.