Package org.processmining.filterbook.filters

Class Filter

java.lang.Object

org.processmining.filterbook.filters.Filter

All Implemented Interfaces:

java.lang.Comparable<Filter>

Direct Known Subclasses:

EventClassifierFilter, EventDateFilter, EventGlobalAttributeFilter, EventOccurrencesClassifierFilter, EventOccurrencesGlobalAttributeFilter, LogGlobalsFilter, NewFilter, TraceDateFilter, TraceDirectlyFollowsClassifierFilter, TraceDirectlyFollowsGlobalAttributeFilter, TraceDurationFilter, TraceFirstLastEventFilter, TraceGlobalAttributeFilter, TraceLastAttributeFilter, TraceLengthFilter, TraceLogFilter, TraceOccurrencesClassifierFilter, TraceOccurrencesGlobalAttributeFilter, TraceSampleFilter, TraceUniqueNameFilter, TraceVariantAbstractClassifierFilter, TraceVariantAbstractGlobalAttributeFilter

public abstract class Filter
extends java.lang.Object
implements java.lang.Comparable<Filter>

Constructor Summary

Constructors

Constructor	Description
Filter(java.lang.String name, Parameters parameters, ComputationCell cell)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Filter o)
abstract void	constructWidget()	Abstract method that constructs a JComponent to enable the user to change the parameters.
abstract org.deckfour.xes.model.XLog	filter()	Abstract method that filters the log using this filter and these parameters.
org.deckfour.xes.model.XLog	filter(boolean doTime)	Filters the log while timing the filtering.
ComputationCell	getCell()
org.deckfour.xes.model.XAttribute	getDummyAttribute()
org.deckfour.xes.classification.XEventClassifier	getDummyClassifier()
org.deckfour.xes.factory.XFactory	getFactory()
org.deckfour.xes.model.XLog	getLog()	Gets the log that is to be filtered.
java.lang.String	getName()	Gets the name of the filter.
Parameters	getParameters()	Gets the parameters of the filter.
abstract FilterTemplate	getTemplate()
javax.swing.JComponent	getWidget()	Gets the widget to change the parameters.
boolean	hasClassifiers()
boolean	hasConceptExtension(org.deckfour.xes.model.XLog log)
boolean	hasEvents()
boolean	hasGlobalConceptName(java.util.Collection<org.deckfour.xes.model.XAttribute> globalAttributes)
boolean	hasGlobalEventAttributes()
boolean	hasGlobalTimestamp()
boolean	hasGlobalTraceAttributes()
boolean	hasTimeExtension()
boolean	hasTraceAttributes()
boolean	hasTraces()
org.deckfour.xes.model.XLog	initializeLog(org.deckfour.xes.model.XLog log)	Creates a copy of the provided log without any traces and/or events.
abstract boolean	isSuitable()
void	setLog(org.deckfour.xes.model.XLog log)	Sets the log that is to be filtered.
void	setSelected(Filter filter)
abstract void	setTemplate(ParametersTemplate parameters)
void	setWidget(javax.swing.JComponent widget)	Sets the widget to change the parameters.
java.lang.String	toString()
void	update()
abstract void	updated(Parameter parameter)	Abstract method that informs the filter that a parameter has been changed.
abstract void	updateParameters()

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter(java.lang.String name,
              Parameters parameters,
              ComputationCell cell)

Method Detail

getName

public java.lang.String getName()

Gets the name of the filter.

Returns:

The name of the filter.

getParameters

public Parameters getParameters()

Gets the parameters of the filter.

Returns:

The parameters of the filter.

filter

public abstract org.deckfour.xes.model.XLog filter()

Abstract method that filters the log using this filter and these parameters.

Returns:

The filtered log.

constructWidget

public abstract void constructWidget()

Abstract method that constructs a JComponent to enable the user to change the parameters.

updated

public abstract void updated(Parameter parameter)

Abstract method that informs the filter that a parameter has been changed.

Parameters:

parameter - The parameter that has been changed.

isSuitable

public abstract boolean isSuitable()

filter

public org.deckfour.xes.model.XLog filter(boolean doTime)

Filters the log while timing the filtering.

Parameters:

doTime - Whether to time the filtering.

Returns:

The filtered log.

initializeLog

public org.deckfour.xes.model.XLog initializeLog(org.deckfour.xes.model.XLog log)

Creates a copy of the provided log without any traces and/or events.

Parameters:

log - The log to copy.

Returns:

The copied log.

getLog

public org.deckfour.xes.model.XLog getLog()

Gets the log that is to be filtered.

Returns:

The log to be filtered.

setLog

public void setLog(org.deckfour.xes.model.XLog log)

Sets the log that is to be filtered.

Parameters:

log - The log to be filtered.

getWidget

public javax.swing.JComponent getWidget()

Gets the widget to change the parameters.

Returns:

The widget to change the parameters.

setWidget

public void setWidget(javax.swing.JComponent widget)

Sets the widget to change the parameters.

Parameters:

widget - The widget to change the parameters.

compareTo

public int compareTo(Filter o)

Specified by:

compareTo in interface java.lang.Comparable<Filter>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCell

public ComputationCell getCell()

getFactory

public org.deckfour.xes.factory.XFactory getFactory()

updateParameters

public abstract void updateParameters()

update

public void update()

setSelected

public void setSelected(Filter filter)

getTemplate

public abstract FilterTemplate getTemplate()

setTemplate

public abstract void setTemplate(ParametersTemplate parameters)

hasGlobalEventAttributes

public boolean hasGlobalEventAttributes()

hasGlobalTraceAttributes

public boolean hasGlobalTraceAttributes()

hasClassifiers

public boolean hasClassifiers()

hasEvents

public boolean hasEvents()

hasTraces

public boolean hasTraces()

hasTraceAttributes

public boolean hasTraceAttributes()

hasTimeExtension

public boolean hasTimeExtension()

hasGlobalTimestamp

public boolean hasGlobalTimestamp()

hasConceptExtension

public boolean hasConceptExtension(org.deckfour.xes.model.XLog log)

hasGlobalConceptName

public boolean hasGlobalConceptName(java.util.Collection<org.deckfour.xes.model.XAttribute> globalAttributes)

getDummyAttribute

public org.deckfour.xes.model.XAttribute getDummyAttribute()

getDummyClassifier

public org.deckfour.xes.classification.XEventClassifier getDummyClassifier()