org.processmining.experttraceclustering.algorithms

Class Clusterer

java.lang.Object

org.processmining.experttraceclustering.algorithms.Clusterer

Direct Known Subclasses:

ParallelClusterer, ParallelConstrainedClusterer, ParallelFullClusterer, ParallelSeededClusterer

public abstract class Clusterer
extends java.lang.Object

Abstract type representing classes that will be able to cluster an log into an ActiTraCClustering. This class already implements everything required for the use of a ClustererEventListener. It also keeps track of ATCParameters, used process model factory and the generated ActiTraCClustering-object.

Author:

Niels Lambrigts (niels.lambrigts@gmail.com), Joch-en De Weerdt (Jochen.DeWeerdt@econ.kuleuven.be)

Constructor Summary

Constructors

Constructor and Description
Clusterer(ImprovedATCParameters parameters, ProcessModelFactory factory) Create a new Clusterer to process the given GroupedXLog, while taking the given parameters in account.
Clusterer(ImprovedATCParameters parameters, ProcessModelFactory factory, ClustererEventListener l) Create a new Clusterer to process the given GroupedXLog, while taking the given parameters in account.
Clusterer(org.processmining.contexts.uitopia.UIPluginContext context, ImprovedATCParameters parameters, ProcessModelFactory factory, ClustererEventListener l) Create a new Clusterer to process the given GroupedXLog, while taking the given parameters in account.

Method Summary

Modifier and Type	Method and Description
void	addClusterEventListener(ClustererEventListener l) Adds the given ClustererEventListener to this Clusterer.
protected void	cancel() Calls ClustererEventListener.cancel() on the event listener and then throws an OperationCancelledException.
abstract void	cluster() Perform the actual processing on the log.
protected void	fireClusterFinishedEvent(Cluster c) Calls ClustererEventListener#clusterFinished(c) on the event listener.
protected void	fireDpiAssignedEvent(int nbTraces, int nbDpiLeft, boolean external) Calls ClustererEventListener.dpiAssigned(int, int, boolean) on the event listener.
protected void	fireEndEvent() Calls ClustererEventListener.end() on the event listener.
protected void	fireImportingEvent() Calls ClustererEventListener.importing() on the event listener.
protected boolean	fireMinimalClusterSizeImpossible() Calls ClustererEventListener.minimalClusterSizeImpossible() on the event listener.
protected void	fireStartEvent() Calls ClustererEventListener.start() on the event listener.
ActiTraCClustering	getClustering() Return the ActiTraCClustering resulting from the calculations done by this object.
protected org.processmining.contexts.uitopia.UIPluginContext	getcontext()
protected ImprovedATCParameters	getParameters() Returns the used ImprovedATCParameters.
protected ProcessModelFactory	getPMFactory()
protected void	setClustering(ActiTraCClustering clustering) Set the resulting ActiTraCClustering of this Clusterer to the given ActiTraCClustering.
protected boolean	shouldCancel() Checks whether this Clusterer should cancel.

Methods inherited from class java.lang.Object

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

Constructor Detail

Clusterer

public Clusterer(ImprovedATCParameters parameters,
                 ProcessModelFactory factory)

Create a new Clusterer to process the given GroupedXLog, while taking the given parameters in account. Any process models created by the clusterer will be created through the provided process model factory.

Parameters:

log - The log to be clustered.

parameters - The ActiTraC-parameters we are to follow.

factory - The used process model factory.

Clusterer

public Clusterer(ImprovedATCParameters parameters,
                 ProcessModelFactory factory,
                 ClustererEventListener l)

Create a new Clusterer to process the given GroupedXLog, while taking the given parameters in account. Any process models created by the clusterer will be created through the provided process model factory.

Parameters:

log - The log to be clustered.

parameters - The ActiTraC-parameters we are to follow.

factory - The used process model factory.

l - The ClustererEventListener that should be assigned to this Clusterer.

Clusterer

public Clusterer(org.processmining.contexts.uitopia.UIPluginContext context,
                 ImprovedATCParameters parameters,
                 ProcessModelFactory factory,
                 ClustererEventListener l)

Create a new Clusterer to process the given GroupedXLog, while taking the given parameters in account. Any process models created by the clusterer will be created through the provided process model factory.

Parameters:

context - The plugin context to use.

log - The log to be clustered.

parameters - The ActiTraC-parameters we are to follow.

factory - The used process model factory.

l - The ClustererEventListener that should be assigned to this Clusterer.

Method Detail

addClusterEventListener

public void addClusterEventListener(ClustererEventListener l)

Adds the given ClustererEventListener to this Clusterer. If an clusterEventListener was already assigned to this Clusterer, it will be removed. Passing null as argument will remove the active current listener, if any exists.

Parameters:

l - The new listener, or null.

cancel

protected void cancel()
               throws org.processmining.plugins.actitrac.utils.OperationCancelledException

Calls ClustererEventListener.cancel() on the event listener and then throws an OperationCancelledException.

Throws:

org.processmining.plugins.actitrac.utils.OperationCancelledException

cluster

public abstract void cluster()
                      throws org.processmining.plugins.actitrac.utils.OperationCancelledException

Perform the actual processing on the log.

Throws:

org.processmining.plugins.actitrac.utils.OperationCancelledException - When the ClusterEventListener that has been assigned to this Clusterer (if any) suggests to cancel this operation.

fireClusterFinishedEvent

protected void fireClusterFinishedEvent(Cluster c)

Calls ClustererEventListener#clusterFinished(c) on the event listener.

Parameters:

c - The newly created cluster.

fireEndEvent

protected void fireEndEvent()

Calls ClustererEventListener.end() on the event listener.

fireMinimalClusterSizeImpossible

protected boolean fireMinimalClusterSizeImpossible()

Calls ClustererEventListener.minimalClusterSizeImpossible() on the event listener.

Returns:

True if the Clusterer should continue, false otherwise.

fireStartEvent

protected void fireStartEvent()

Calls ClustererEventListener.start() on the event listener.

getClustering

public ActiTraCClustering getClustering()

Return the ActiTraCClustering resulting from the calculations done by this object. The result of this method is not defined before the method cluster() has been called on this object.

setClustering

protected void setClustering(ActiTraCClustering clustering)

Set the resulting ActiTraCClustering of this Clusterer to the given ActiTraCClustering.

shouldCancel

protected boolean shouldCancel()

Checks whether this Clusterer should cancel. This is done through the method ClustererEventListener.shouldCancel(). This method should return true if this clusterer should cancel.

fireImportingEvent

protected void fireImportingEvent()

Calls ClustererEventListener.importing() on the event listener.

fireDpiAssignedEvent

protected void fireDpiAssignedEvent(int nbTraces,
                                    int nbDpiLeft,
                                    boolean external)

Calls ClustererEventListener.dpiAssigned(int, int, boolean) on the event listener.

getParameters

protected ImprovedATCParameters getParameters()

Returns the used ImprovedATCParameters.

getPMFactory

protected ProcessModelFactory getPMFactory()

getcontext

protected org.processmining.contexts.uitopia.UIPluginContext getcontext()