org.processmining.plugins.log.ui.logoverview.filter

Class FilterLog

java.lang.Object

org.processmining.plugins.log.ui.logoverview.filter.FilterLog

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<org.deckfour.xes.model.XTrace>, java.util.Collection<org.deckfour.xes.model.XTrace>, java.util.List<org.deckfour.xes.model.XTrace>, org.deckfour.xes.model.XAttributable, org.deckfour.xes.model.XElement, org.deckfour.xes.model.XLog

public class FilterLog
extends java.lang.Object
implements org.deckfour.xes.model.XLog

XLog wrapper that keeps a record of removed traces. Traces are not actually removed, but are inaccessible to the outside from then on. This wrapper is primarily used for the purpose of filtering, while keeping the original log intact for lookups of Event IDs used in tagging and filtering operations. NOTE: currently, list operations like retainAll and removeAll are implemented in order to implement the complete XLog interface, but for now are untested.

Author:

Danny van Heumen

Constructor Summary

Constructors

Constructor and Description
FilterLog(org.deckfour.xes.model.XLog log)
FilterLog(org.deckfour.xes.model.XLog log, java.util.List<java.util.List<java.lang.Integer>> events)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(org.deckfour.xes.model.XVisitor arg0)
void	add(int index, org.deckfour.xes.model.XTrace element)
boolean	add(org.deckfour.xes.model.XTrace e)
boolean	addAll(java.util.Collection<? extends org.deckfour.xes.model.XTrace> c)
boolean	addAll(int index, java.util.Collection<? extends org.deckfour.xes.model.XTrace> c)
void	cleanUp() Clean up remaining traces: check all traces for empty traces and remove them.
void	clear()
org.deckfour.xes.model.XLog	clone() Clone the FilterLog.
boolean	contains(java.lang.Object trace)
boolean	containsAll(java.util.Collection<?> c)
java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID>	convertToFiltered(java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> events) Convert set of Event IDs (from the original log) to a set that corresponds to the filtered log in its current state.
java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID>	convertToOriginal(java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> events) Convert set of Event IDs (from the filtered log in its current state) to a set that corresponds to the original log.
boolean	equals(java.lang.Object object) Check whether or not some log is equal to this log.
org.deckfour.xes.model.XLog	generateXLogInstance() Generate a new (true) XLog instance using the currently active filter state.
org.deckfour.xes.model.XTrace	get(int index)
org.deckfour.xes.model.XAttributeMap	getAttributes() Return the attributes belonging to this XLog instance.
java.util.List<org.deckfour.xes.classification.XEventClassifier>	getClassifiers()
java.util.Set<org.deckfour.xes.extension.XExtension>	getExtensions()
java.util.List<org.deckfour.xes.model.XAttribute>	getGlobalEventAttributes()
java.util.List<org.deckfour.xes.model.XAttribute>	getGlobalTraceAttributes()
org.deckfour.xes.info.XLogInfo	getInfo(org.deckfour.xes.classification.XEventClassifier arg0)
java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID>	getRemainingEvents()
boolean	hasAttributes()
int	indexOf(java.lang.Object trace)
int	indexOfOriginalId(int originalTraceId) Return the current state index of the trace of which the id is specified.
boolean	isEmpty()
boolean	isPristine() Test whether or not the log has been filtered, or whether it is still the unaltered log.
java.util.Iterator<org.deckfour.xes.model.XTrace>	iterator()
int	lastIndexOf(java.lang.Object trace)
java.util.ListIterator<org.deckfour.xes.model.XTrace>	listIterator()
java.util.ListIterator<org.deckfour.xes.model.XTrace>	listIterator(int index)
org.deckfour.xes.model.XTrace	remove(int index)
boolean	remove(java.lang.Object trace)
boolean	removeAll(java.util.Collection<?> c)
void	reset() Reset filter log to original log (i.e.
boolean	retainAll(java.util.Collection<?> c)
org.deckfour.xes.model.XTrace	set(int index, org.deckfour.xes.model.XTrace trace)
void	setAttributes(org.deckfour.xes.model.XAttributeMap attributes)
void	setInfo(org.deckfour.xes.classification.XEventClassifier arg0, org.deckfour.xes.info.XLogInfo arg1)
void	setRemainingEvents(java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> remainingEvents) Specify a new SortedSet of Event IDs as the set of remaining events.
int	size()
java.util.List<org.deckfour.xes.model.XTrace>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

hashCode

Constructor Detail

FilterLog

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

FilterLog

public FilterLog(org.deckfour.xes.model.XLog log,
         java.util.List<java.util.List<java.lang.Integer>> events)

Method Detail

equals

public boolean equals(java.lang.Object object)

Check whether or not some log is equal to this log. A log is considered equal if both logs contain the same traces (also in the same order), and all traces are considered equal.

Specified by:

equals in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

equals in interface java.util.List<org.deckfour.xes.model.XTrace>

Overrides:

equals in class java.lang.Object

isPristine

public boolean isPristine()

Test whether or not the log has been filtered, or whether it is still the unaltered log.

Returns:

Returns true if the log is unaltered, or false if it has been changed.

reset

public void reset()

Reset filter log to original log (i.e. discard earlier changes) This will also discard changes made to individual traces as it is required that traces are not empty.

cleanUp

public void cleanUp()

Clean up remaining traces: check all traces for empty traces and remove them. (XES standard does not allow empty traces to exist.)

Throws:

java.lang.IllegalStateException - Throws an IllegalStateException whenever the resulting event log is not valid according to the XES Standard. This may happen when an XLog instance contains 0 traces.

clone

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

Clone the FilterLog. Clones the original log, since some plugin may make (limited) changes to it. Keep the set of FilterTraces, since we want to link the logs for the purpose of manipulating the list of event indices in case of deleted events.

Specified by:

clone in interface org.deckfour.xes.model.XElement

Overrides:

clone in class java.lang.Object

indexOfOriginalId

public int indexOfOriginalId(int originalTraceId)

Return the current state index of the trace of which the id is specified.

Parameters:

originalTraceId - Original Trace ID to search for.

Returns:

Current index of the trace or -1 if the trace is not available in the current state.

getRemainingEvents

public java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> getRemainingEvents()

setRemainingEvents

public void setRemainingEvents(java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> remainingEvents)

Specify a new SortedSet of Event IDs as the set of remaining events.

Parameters:

remainingEvents - The set of remaining events.

convertToFiltered

public java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> convertToFiltered(java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> events)

Convert set of Event IDs (from the original log) to a set that corresponds to the filtered log in its current state. Note: translating from the original set to the filtered set of Event IDs can cause problems when events have been filtered out. (The filtered set of events is a subset of the original set of events.) These events will be dropped and thus will not occur in the convert set.

Parameters:

events - Set of events with Event IDs corresponding to the original log.

Returns:

Set of events with Event IDs corresponding to the filtered log.

convertToOriginal

public java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> convertToOriginal(java.util.SortedSet<org.processmining.plugins.interactivevisualization.EID> events)

Convert set of Event IDs (from the filtered log in its current state) to a set that corresponds to the original log. Note: Translating back to the original Event IDs will not cause problems, since the filtered set is a subset of the original set.

Parameters:

events - Set of events with Event IDs corresponding to the filtered log.

Returns:

Set of events with Event IDs corresponding to the original log.

generateXLogInstance

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

Generate a new (true) XLog instance using the currently active filter state.

Returns:

Returns a new instance of XLog according to the currently active filter state.

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface org.deckfour.xes.model.XAttributable

getAttributes

public org.deckfour.xes.model.XAttributeMap getAttributes()

Return the attributes belonging to this XLog instance.

Specified by:

getAttributes in interface org.deckfour.xes.model.XAttributable

setAttributes

public void setAttributes(org.deckfour.xes.model.XAttributeMap attributes)

Specified by:

setAttributes in interface org.deckfour.xes.model.XAttributable

getExtensions

public java.util.Set<org.deckfour.xes.extension.XExtension> getExtensions()

Specified by:

getExtensions in interface org.deckfour.xes.model.XAttributable

add

public boolean add(org.deckfour.xes.model.XTrace e)

Specified by:

add in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

add in interface java.util.List<org.deckfour.xes.model.XTrace>

add

public void add(int index,
       org.deckfour.xes.model.XTrace element)

Specified by:

add in interface java.util.List<org.deckfour.xes.model.XTrace>

addAll

public boolean addAll(java.util.Collection<? extends org.deckfour.xes.model.XTrace> c)

Specified by:

addAll in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

addAll in interface java.util.List<org.deckfour.xes.model.XTrace>

addAll

public boolean addAll(int index,
             java.util.Collection<? extends org.deckfour.xes.model.XTrace> c)

Specified by:

addAll in interface java.util.List<org.deckfour.xes.model.XTrace>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

clear in interface java.util.List<org.deckfour.xes.model.XTrace>

contains

public boolean contains(java.lang.Object trace)

Specified by:

contains in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

contains in interface java.util.List<org.deckfour.xes.model.XTrace>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

containsAll in interface java.util.List<org.deckfour.xes.model.XTrace>

get

public org.deckfour.xes.model.XTrace get(int index)

Specified by:

get in interface java.util.List<org.deckfour.xes.model.XTrace>

indexOf

public int indexOf(java.lang.Object trace)

Specified by:

indexOf in interface java.util.List<org.deckfour.xes.model.XTrace>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

isEmpty in interface java.util.List<org.deckfour.xes.model.XTrace>

iterator

public java.util.Iterator<org.deckfour.xes.model.XTrace> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.deckfour.xes.model.XTrace>

Specified by:

iterator in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

iterator in interface java.util.List<org.deckfour.xes.model.XTrace>

lastIndexOf

public int lastIndexOf(java.lang.Object trace)

Specified by:

lastIndexOf in interface java.util.List<org.deckfour.xes.model.XTrace>

listIterator

public java.util.ListIterator<org.deckfour.xes.model.XTrace> listIterator()

Specified by:

listIterator in interface java.util.List<org.deckfour.xes.model.XTrace>

listIterator

public java.util.ListIterator<org.deckfour.xes.model.XTrace> listIterator(int index)

Specified by:

listIterator in interface java.util.List<org.deckfour.xes.model.XTrace>

remove

public boolean remove(java.lang.Object trace)

Specified by:

remove in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

remove in interface java.util.List<org.deckfour.xes.model.XTrace>

remove

public org.deckfour.xes.model.XTrace remove(int index)

Specified by:

remove in interface java.util.List<org.deckfour.xes.model.XTrace>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

removeAll in interface java.util.List<org.deckfour.xes.model.XTrace>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

retainAll in interface java.util.List<org.deckfour.xes.model.XTrace>

set

public org.deckfour.xes.model.XTrace set(int index,
                                org.deckfour.xes.model.XTrace trace)

Specified by:

set in interface java.util.List<org.deckfour.xes.model.XTrace>

size

public int size()

Specified by:

size in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

size in interface java.util.List<org.deckfour.xes.model.XTrace>

subList

public java.util.List<org.deckfour.xes.model.XTrace> subList(int fromIndex,
                                                    int toIndex)

Specified by:

subList in interface java.util.List<org.deckfour.xes.model.XTrace>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

toArray in interface java.util.List<org.deckfour.xes.model.XTrace>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<org.deckfour.xes.model.XTrace>

Specified by:

toArray in interface java.util.List<org.deckfour.xes.model.XTrace>

getClassifiers

public java.util.List<org.deckfour.xes.classification.XEventClassifier> getClassifiers()

Specified by:

getClassifiers in interface org.deckfour.xes.model.XLog

getGlobalTraceAttributes

public java.util.List<org.deckfour.xes.model.XAttribute> getGlobalTraceAttributes()

Specified by:

getGlobalTraceAttributes in interface org.deckfour.xes.model.XLog

getGlobalEventAttributes

public java.util.List<org.deckfour.xes.model.XAttribute> getGlobalEventAttributes()

Specified by:

getGlobalEventAttributes in interface org.deckfour.xes.model.XLog

accept

public boolean accept(org.deckfour.xes.model.XVisitor arg0)

Specified by:

accept in interface org.deckfour.xes.model.XLog

getInfo

public org.deckfour.xes.info.XLogInfo getInfo(org.deckfour.xes.classification.XEventClassifier arg0)

Specified by:

getInfo in interface org.deckfour.xes.model.XLog

setInfo

public void setInfo(org.deckfour.xes.classification.XEventClassifier arg0,
           org.deckfour.xes.info.XLogInfo arg1)

Specified by:

setInfo in interface org.deckfour.xes.model.XLog