Package org.processmining.plugins.log.logfilters.impl

Class EventLogFilter

java.lang.Object

org.processmining.plugins.log.logfilters.impl.EventLogFilter

public class EventLogFilter
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
EventLogFilter()

Method Summary

Modifier and Type	Method	Description
org.deckfour.xes.model.XLog	filterWithBoth(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, org.deckfour.xes.classification.XEventClasses allEventClasses, org.deckfour.xes.classification.XEventClass[] eventClassesToKeep, java.lang.Double minOccurrence, java.lang.Double minCases, java.lang.Boolean fullfillBoth)	This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the getName() of XEvent is not contained in the given set of labels.
org.deckfour.xes.model.XLog	filterWithClassifier(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, org.deckfour.xes.classification.XEventClassifier classifier, java.lang.String[] selectedIds)
org.deckfour.xes.model.XLog	filterWithMinCases(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, org.deckfour.xes.classification.XEventClasses allEventClasses, org.deckfour.xes.classification.XEventClass[] eventClassesToKeep, java.lang.Double minCases)	This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the getName() of XEvent is not contained in the given set of labels.
org.deckfour.xes.model.XLog	filterWithMinOccFreq(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, org.deckfour.xes.classification.XEventClasses allEventClasses, org.deckfour.xes.classification.XEventClass[] eventClassesToKeep, java.lang.Double minOccurrence)	This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the getName() of XEvent is not contained in the given set of labels.
org.deckfour.xes.model.XLog	filterWithNames(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, org.deckfour.xes.classification.XEventClasses allEventClasses, org.deckfour.xes.classification.XEventClass[] eventClassesToKeep)	This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the XEventClass belonging to this XEvent is not provided in the given XEventClasses object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventLogFilter

public EventLogFilter()

Method Detail

filterWithNames

public org.deckfour.xes.model.XLog filterWithNames(org.processmining.framework.plugin.PluginContext context,
                                                   org.deckfour.xes.model.XLog log,
                                                   org.deckfour.xes.classification.XEventClasses allEventClasses,
                                                   org.deckfour.xes.classification.XEventClass[] eventClassesToKeep)

This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the XEventClass belonging to this XEvent is not provided in the given XEventClasses object

Parameters:

context - The pluginContext in which this plugin is executed

log - The log that needs to be filtered.

allEventClasses - All event classes

events - The event classes that should be kept in the log. Events not belonging to these classes are removed, after which emtpy traces are also removed

Returns:

the filtered log

filterWithClassifier

public org.deckfour.xes.model.XLog filterWithClassifier(org.processmining.framework.plugin.PluginContext context,
                                                        org.deckfour.xes.model.XLog log,
                                                        org.deckfour.xes.classification.XEventClassifier classifier,
                                                        java.lang.String[] selectedIds)

filterWithMinOccFreq

public org.deckfour.xes.model.XLog filterWithMinOccFreq(org.processmining.framework.plugin.PluginContext context,
                                                        org.deckfour.xes.model.XLog log,
                                                        org.deckfour.xes.classification.XEventClasses allEventClasses,
                                                        org.deckfour.xes.classification.XEventClass[] eventClassesToKeep,
                                                        java.lang.Double minOccurrence)

This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the getName() of XEvent is not contained in the given set of labels. Note that the percentages are based on the original log, not on the log with the unnecessary events removed.

Parameters:

context - The pluginContext in which this plugin is executed

log - The log that needs to be filtered.

allEventClasses - All event classes

eventClassesToKeep - The event classes that should be kept in the log. Events not belonging to these classes are removed, after which emtpy traces are also removed

minOccurrence - All events with an event class which represent less than this percentage of the events in the log are removed. Value should be 0 <= minOccurrence <= 1. If 0, then all events are kept, if 1, then no events are kept.

Returns:

the filtered log

filterWithMinCases

public org.deckfour.xes.model.XLog filterWithMinCases(org.processmining.framework.plugin.PluginContext context,
                                                      org.deckfour.xes.model.XLog log,
                                                      org.deckfour.xes.classification.XEventClasses allEventClasses,
                                                      org.deckfour.xes.classification.XEventClass[] eventClassesToKeep,
                                                      java.lang.Double minCases)

This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the getName() of XEvent is not contained in the given set of labels. Note that the percentages are based on the original log, not on the log with the unnecessary events removed.

Parameters:

context - The pluginContext in which this plugin is executed

log - The log that needs to be filtered.

allEventClasses - All event classes

eventClassesToKeep - The event classes that should be kept in the log. Events not belonging to these classes are removed, after which emtpy traces are also removed

minCases - All events which occur in less than minCasses percent of the cases are removed. Value should be 0 <= minCases <= 1. If 0, then all events are kept, if 1, then only events appearing in all cases are kept.

Returns:

the filtered log

filterWithBoth

public org.deckfour.xes.model.XLog filterWithBoth(org.processmining.framework.plugin.PluginContext context,
                                                  org.deckfour.xes.model.XLog log,
                                                  org.deckfour.xes.classification.XEventClasses allEventClasses,
                                                  org.deckfour.xes.classification.XEventClass[] eventClassesToKeep,
                                                  java.lang.Double minOccurrence,
                                                  java.lang.Double minCases,
                                                  java.lang.Boolean fullfillBoth)

This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the getName() of XEvent is not contained in the given set of labels. Note that the percentages are based on the original log, not on the log with the unnecessary events removed.

Parameters:

context - The pluginContext in which this plugin is executed

log - The log that needs to be filtered.

allEventClasses - All event classes

eventClassesToKeep - The event classes that should be kept in the log. Events not belonging to these classes are removed, after which emtpy traces are also removed

minOccurrence - All events with an event class which represent less than this percentage of the events in the log are removed. Value should be 0 <= minOccurrence <= 1. If 0, then all events are kept, if 1, then no events are kept.

minCases - All events which occur in less than minCasses percent of the cases are removed. Value should be 0 <= minCases <= 1. If 0, then all events are kept, if 1, then only events appearing in all cases are kept.

fullfillBoth - A boolean indicating wheter both minimal frequencies should be obeyed (true) or whether one is enough (false)

Returns:

the filtered log