weka.gui.beans
Class BatchClustererEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byweka.gui.beans.BatchClustererEvent
All Implemented Interfaces:
java.io.Serializable

public class BatchClustererEvent
extends java.util.EventObject

Class encapsulating a built clusterer and a batch of instances to test on.

Since:
1.0
Version:
$Revision: 1.1 $
Author:
Stefan Mutter
See Also:
EventObject, Serialized Form

Constructor Summary
BatchClustererEvent(java.lang.Object source, Clusterer scheme, DataSetEvent tstI, int setNum, int maxSetNum, int testOrTrain)
          Creates a new BatchClustererEvent instance.
 
Method Summary
 Clusterer getClusterer()
          Get the clusterer
 int getMaxSetNumber()
          Get the maximum set number (ie the total number of training and testing sets in the series).
 int getSetNumber()
          Get the set number (ie which fold this is)
 int getTestOrTrain()
          Get whether the set of instances is a test or a training set
 DataSetEvent getTestSet()
          Get the training/test set
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BatchClustererEvent

public BatchClustererEvent(java.lang.Object source,
                           Clusterer scheme,
                           DataSetEvent tstI,
                           int setNum,
                           int maxSetNum,
                           int testOrTrain)
Creates a new BatchClustererEvent instance.

Parameters:
source - the source object
scheme - a Clusterer
tstI - the training/test instances
setNum - the set number of the training/testinstances
maxSetNum - the last set number in the series
testOrTrain - 0 if the set is a test set, >0 if it is a training set
Method Detail

getClusterer

public Clusterer getClusterer()
Get the clusterer

Returns:
the clusterer

getTestSet

public DataSetEvent getTestSet()
Get the training/test set

Returns:
the training/testing instances

getSetNumber

public int getSetNumber()
Get the set number (ie which fold this is)

Returns:
the set number for the training and testing data sets encapsulated in this event

getMaxSetNumber

public int getMaxSetNumber()
Get the maximum set number (ie the total number of training and testing sets in the series).

Returns:
the maximum set number

getTestOrTrain

public int getTestOrTrain()
Get whether the set of instances is a test or a training set

Returns:
0 for test set, >0 fro training set