org.processmining.framework.log.filter
Class DefaultLogFilter

java.lang.Object
  extended by org.processmining.framework.log.LogFilter
      extended by org.processmining.framework.log.filter.DefaultLogFilter

public class DefaultLogFilter
extends LogFilter

This logFilter filters the log based on the event types of audittrailentries. The following options are available: 1) INCLUDE: Include all AuditTrailEntries 2) DISCARD: Ignore the AuditTrailEntry, but not the ProcessInstance 3) DISCARD_INSTANCE: Ignore the whole ProcessInstance if a certain LogEvent is found. During construction, a default behaviour can be given. Then afterwards, using the method filterEventType(), specific events can be filtered. ProcessInstances are also ignored if their getProcess does not equal the process set by setProcess in this filter. ProcessInstances are ignored if they turn out to be empty after filtering.

Version:
1.0
Author:
Peter van den Brand

Field Summary
static int DISCARD
           
static int DISCARD_INSTANCE
           
static int INCLUDE
           
 
Fields inherited from class org.processmining.framework.log.LogFilter
FAST, filter, load, MODERATE, SLOW
 
Constructor Summary
DefaultLogFilter()
           
DefaultLogFilter(int defaultBehavior)
           
 
Method Summary
protected  boolean doFiltering(ProcessInstance instance)
          Filters a single process instance.
 void filterEventType(java.lang.String type, int action)
           
protected  java.lang.String getHelpForThisLogFilter()
          Returns the help for this LogFilter as HTML text, but without the and tags!
 LogFilterParameterDialog getParameterDialog(LogSummary summary)
          Returns a Panel for the setting of parameters.
 java.lang.String getProcess()
           
protected  void readSpecificXML(org.w3c.dom.Node logFilterSpecifcNode)
          Read the inside of the tag in the XML export file from the InputStream input.
 void setProcess(java.lang.String name)
           
 boolean thisFilterChangesLog()
          The log is changes, since events are removed that do not refer to specific events types.
protected  void writeSpecificXML(java.io.BufferedWriter output)
          Write the inside of the tag in the XML export file to the OutputStream output.
 
Methods inherited from class org.processmining.framework.log.LogFilter
changesLog, filter, getComplexity, getComplexityAsString, getFilter, getHelp, getName, getThisLogFilterComplexity, readXML, setLowLevelFilter, setName, toString, writeXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INCLUDE

public static final int INCLUDE
See Also:
Constant Field Values

DISCARD

public static final int DISCARD
See Also:
Constant Field Values

DISCARD_INSTANCE

public static final int DISCARD_INSTANCE
See Also:
Constant Field Values
Constructor Detail

DefaultLogFilter

public DefaultLogFilter()

DefaultLogFilter

public DefaultLogFilter(int defaultBehavior)
Method Detail

filterEventType

public void filterEventType(java.lang.String type,
                            int action)

setProcess

public void setProcess(java.lang.String name)

getProcess

public java.lang.String getProcess()

doFiltering

protected boolean doFiltering(ProcessInstance instance)
Description copied from class: LogFilter
Filters a single process instance. The process instance can be modified.

Specified by:
doFiltering in class LogFilter
Parameters:
instance - the process instance to filter
Returns:
true if the whole process instance passes the filter, false if the process instance should be discarded.

thisFilterChangesLog

public boolean thisFilterChangesLog()
The log is changes, since events are removed that do not refer to specific events types.

Specified by:
thisFilterChangesLog in class LogFilter
Returns:
boolean true

getParameterDialog

public LogFilterParameterDialog getParameterDialog(LogSummary summary)
Description copied from class: LogFilter
Returns a Panel for the setting of parameters. When a LogFilter can be added to a list in the framework. This panel is shown, and parameters can be set. When the dialog is closed, a new instance of a LogFilter is created by the framework by calling the getNewLogFilter method of the dialog.

Specified by:
getParameterDialog in class LogFilter
Parameters:
summary - A LogSummary to be used for setting parameters.
Returns:
JPanel

getHelpForThisLogFilter

protected java.lang.String getHelpForThisLogFilter()
Description copied from class: LogFilter
Returns the help for this LogFilter as HTML text, but without the and tags!

Specified by:
getHelpForThisLogFilter in class LogFilter
Returns:
the help as string

writeSpecificXML

protected void writeSpecificXML(java.io.BufferedWriter output)
                         throws java.io.IOException
Write the inside of the tag in the XML export file to the OutputStream output.

Specified by:
writeSpecificXML in class LogFilter
Parameters:
output - OutputStream
Throws:
java.io.IOException

readSpecificXML

protected void readSpecificXML(org.w3c.dom.Node logFilterSpecifcNode)
                        throws java.io.IOException
Read the inside of the tag in the XML export file from the InputStream input.

Specified by:
readSpecificXML in class LogFilter
Parameters:
input - InputStream
Throws:
java.io.IOException