weka.gui.beans

Class BatchClustererEvent

java.lang.Object

java.util.EventObject

weka.gui.beans.BatchClustererEvent

All Implemented Interfaces:

Serializable

public class BatchClustererEvent
extends EventObject

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

Since:

1.0

Version:

$Revision: 1.4 $

Author:

Stefan Mutter

See Also:

EventObject, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Clusterer	m_clusterer The clusterer
protected int	m_maxSetNumber The last set number for this series
protected int	m_setNumber The set number for the test set
protected int	m_testOrTrain Indicates if m_testSet is a training or a test set.
protected DataSetEvent	m_testSet Training or Test Instances
static int	TEST
static int	TRAINING

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BatchClustererEvent(Object source, Clusterer scheme, DataSetEvent tstI, int setNum, int maxSetNum, int testOrTrain) Creates a new BatchClustererEvent instance.

Method Summary

Modifier and Type	Method and Description
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

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

Field Detail

m_clusterer

protected Clusterer m_clusterer

The clusterer

m_testSet

protected DataSetEvent m_testSet

Training or Test Instances

m_setNumber

protected int m_setNumber

The set number for the test set

m_testOrTrain

protected int m_testOrTrain

Indicates if m_testSet is a training or a test set. 0 for test, >0 for training

m_maxSetNumber

protected int m_maxSetNumber

The last set number for this series

TEST

public static int TEST

TRAINING

public static int TRAINING

Constructor Detail

BatchClustererEvent

public BatchClustererEvent(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