org.processmining.experttraceclustering.dialogs

Class ClustererEventListenerUI

java.lang.Object

org.processmining.experttraceclustering.dialogs.ClustererEventListenerUI

All Implemented Interfaces:

ClustererEventListener

public class ClustererEventListenerUI
extends java.lang.Object
implements ClustererEventListener

This implementation of a ClustererEventListener forms a bridge between a Clusterer object and a UIPluginContext. It shall reflect the progress of the Clusterer in the UIPluginContext and correctly implement the UI's cancel-operation.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ClustererEventListenerUI(org.processmining.contexts.uitopia.UIPluginContext context, org.deckfour.xes.model.XLog log) Create a new ClustererEventListenerUI for the given UIPluginContext, XLog and ATCParameters.

Method Summary

Modifier and Type	Method and Description
void	cancel() You should call this method when the underlying Clusterer has cancelled.
void	clusterFinished(Cluster c) Indicates that a new Cluster has been finished by the algorithm.
void	dpiAssigned(int nbTraces, int nbDpiLeft, boolean external) Indicates that a dpi has been assigned to a cluster.
void	end() Indicates that the processing has finished.
void	importing() Indicates that the Clusterer is currently importing data.
boolean	minimalClusterSizeImpossible() This method is called when the clustering algorithm is unable to find a cluster that satisfies the minimal cluster size without decreasing the fitness of the cluster.
boolean	shouldCancel() This method should return true when the Clusterer should cancel.
void	start() Indicates that the clustering has started.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClustererEventListenerUI

public ClustererEventListenerUI(org.processmining.contexts.uitopia.UIPluginContext context,
                                org.deckfour.xes.model.XLog log)

Create a new ClustererEventListenerUI for the given UIPluginContext, XLog and ATCParameters.

Method Detail

cancel

public void cancel()

Description copied from interface: ClustererEventListener

You should call this method when the underlying Clusterer has cancelled.

Specified by:

cancel in interface ClustererEventListener

clusterFinished

public void clusterFinished(Cluster c)

Description copied from interface: ClustererEventListener

Indicates that a new Cluster has been finished by the algorithm.

Specified by:

clusterFinished in interface ClustererEventListener

end

public void end()

Description copied from interface: ClustererEventListener

Indicates that the processing has finished.

Specified by:

end in interface ClustererEventListener

minimalClusterSizeImpossible

public boolean minimalClusterSizeImpossible()

Description copied from interface: ClustererEventListener

This method is called when the clustering algorithm is unable to find a cluster that satisfies the minimal cluster size without decreasing the fitness of the cluster. This method should indicate whether the Clusterer should continue operation after generating this error.

Specified by:

minimalClusterSizeImpossible in interface ClustererEventListener

Returns:

True if the Clusterer is allowed to continue operation, false otherwise.

shouldCancel

public boolean shouldCancel()

Description copied from interface: ClustererEventListener

This method should return true when the Clusterer should cancel.

Specified by:

shouldCancel in interface ClustererEventListener

start

public void start()

Description copied from interface: ClustererEventListener

Indicates that the clustering has started. This is roughly equivalent to having called Clusterer.cluster().

Specified by:

start in interface ClustererEventListener

importing

public void importing()

Description copied from interface: ClustererEventListener

Indicates that the Clusterer is currently importing data.

Specified by:

importing in interface ClustererEventListener

dpiAssigned

public void dpiAssigned(int nbTraces,
                        int nbDpiLeft,
                        boolean external)

Description copied from interface: ClustererEventListener

Indicates that a dpi has been assigned to a cluster.

Specified by:

dpiAssigned in interface ClustererEventListener

Parameters:

nbTraces - The amount of traces in the dpi that was assigned.

nbDpiLeft - The amount of dpi that are still unassigned.

external - Whether or not this trace has been added externally to a cluster. A value of true indicates external, false is internal.