org.processmining.plugins.log.logfilters.impl
Class OriginatorLogFilter

java.lang.Object
  extended by org.processmining.plugins.log.logfilters.impl.OriginatorLogFilter

public class OriginatorLogFilter
extends java.lang.Object


Constructor Summary
OriginatorLogFilter()
           
 
Method Summary
 org.deckfour.xes.model.XLog filterWithAll(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] namesToKeep, java.lang.String[] groupsToKeep, java.lang.String[] rolesToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of resources, or in the given set of roles, or in the given set of groups.
 org.deckfour.xes.model.XLog filterWithGroups(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] groupsToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of groups.
 org.deckfour.xes.model.XLog filterWithGroupsAndRoles(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] groupsToKeep, java.lang.String[] rolesToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of groups, or in the given set of roles.
 org.deckfour.xes.model.XLog filterWithNames(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] namesToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the resource of XEvent is not contained in the given set of resources.
 org.deckfour.xes.model.XLog filterWithNamesAndGroups(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] namesToKeep, java.lang.String[] groupsToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the resource of XEvent is not contained in the given set of resources, or in the given set of groups.
 org.deckfour.xes.model.XLog filterWithNamesAndRoles(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] namesToKeep, java.lang.String[] rolesToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of resources, or in the given set of roles.
 org.deckfour.xes.model.XLog filterWithRoles(org.processmining.framework.plugin.PluginContext context, org.deckfour.xes.model.XLog log, java.lang.String[] rolesToKeep)
          This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the role of XEvent is not contained in the given set of roles.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OriginatorLogFilter

public OriginatorLogFilter()
Method Detail

filterWithNames

public org.deckfour.xes.model.XLog filterWithNames(org.processmining.framework.plugin.PluginContext context,
                                                   org.deckfour.xes.model.XLog log,
                                                   java.lang.String[] namesToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the resource of XEvent is not contained in the given set of resources. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
namesToKeep - The names of the resources to keep
Returns:
the filtered log

filterWithGroups

public org.deckfour.xes.model.XLog filterWithGroups(org.processmining.framework.plugin.PluginContext context,
                                                    org.deckfour.xes.model.XLog log,
                                                    java.lang.String[] groupsToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of groups. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
groupsToKeep - The names of the groups to keep
Returns:
the filtered log

filterWithRoles

public org.deckfour.xes.model.XLog filterWithRoles(org.processmining.framework.plugin.PluginContext context,
                                                   org.deckfour.xes.model.XLog log,
                                                   java.lang.String[] rolesToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the role of XEvent is not contained in the given set of roles. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
rolesToKeep - The names of the roles to keep
Returns:
the filtered log

filterWithNamesAndGroups

public org.deckfour.xes.model.XLog filterWithNamesAndGroups(org.processmining.framework.plugin.PluginContext context,
                                                            org.deckfour.xes.model.XLog log,
                                                            java.lang.String[] namesToKeep,
                                                            java.lang.String[] groupsToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the resource of XEvent is not contained in the given set of resources, or in the given set of groups. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
namesToKeep - The names of the resources to keep
groupsToKeep - The names of the groups to keep
Returns:
the filtered log

filterWithGroupsAndRoles

public org.deckfour.xes.model.XLog filterWithGroupsAndRoles(org.processmining.framework.plugin.PluginContext context,
                                                            org.deckfour.xes.model.XLog log,
                                                            java.lang.String[] groupsToKeep,
                                                            java.lang.String[] rolesToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of groups, or in the given set of roles. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
groupsToKeep - The names of the groups to keep
rolesToKeep - The names of the roles to keep
Returns:
the filtered log

filterWithNamesAndRoles

public org.deckfour.xes.model.XLog filterWithNamesAndRoles(org.processmining.framework.plugin.PluginContext context,
                                                           org.deckfour.xes.model.XLog log,
                                                           java.lang.String[] namesToKeep,
                                                           java.lang.String[] rolesToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of resources, or in the given set of roles. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
namesToKeep - The names of the resources to keep
rolesToKeep - The names of the roles to keep
Returns:
the filtered log

filterWithAll

public org.deckfour.xes.model.XLog filterWithAll(org.processmining.framework.plugin.PluginContext context,
                                                 org.deckfour.xes.model.XLog log,
                                                 java.lang.String[] namesToKeep,
                                                 java.lang.String[] groupsToKeep,
                                                 java.lang.String[] rolesToKeep)
This method filters a log by removing XEvent objects from all XTrace object in the given XLog, if the group of XEvent is not contained in the given set of resources, or in the given set of roles, or in the given set of groups. If no resource information is available in the log, all events are removed.

Parameters:
context - The pluginContext in which this plugin is executed
log - The log that needs to be filtered.
namesToKeep - The names of the resources to keep
groupsToKeep - The names of the resources to keep
rolesToKeep - The names of the roles to keep
Returns:
the filtered log