org.processmining.experttraceclustering.utils

Interface ClustererEventListener

All Known Implementing Classes:

ClustererEventListenerUI

public interface ClustererEventListener

This interface specifies event listeners for use with the Clusterer -class.

Author:

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

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.

Method Detail

cancel

void cancel()

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

clusterFinished

void clusterFinished(Cluster c)

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

end

void end()

Indicates that the processing has finished.

minimalClusterSizeImpossible

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. This method should indicate whether the Clusterer should continue operation after generating this error.

Returns:

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

shouldCancel

boolean shouldCancel()

This method should return true when the Clusterer should cancel.

start

void start()

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

dpiAssigned

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

Indicates that a dpi has been assigned to a cluster.

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.

importing

void importing()

Indicates that the Clusterer is currently importing data.