All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.experiment.Experiment

java.lang.Object
   |
   +----weka.experiment.Experiment

public class Experiment

extends Object

implements Serializable, OptionHandler

Version:

$Revision: 1.3 $

Author:

Len Trigg (trigg@cs.waikato.ac.nz)

Experiment()

advanceCounters()

Increments iteration counters appropriately.

getCurrentDatasetNumber()

When an experiment is running, this returns the current dataset number.

getCurrentPropertyNumber()

When an experiment is running, this returns the index of the current custom property value.

getCurrentRunNumber()

When an experiment is running, this returns the current run number.

getDatasets()

Gets the datasets in the experiment.

getNotes()

Get the user notes.

getOptions()

Gets the current settings of the experiment iterator.

getPropertyArray()

Gets the array of values to set the custom property to.

getPropertyArrayLength()

Gets the number of custom iterator values that have been defined for the experiment.

getPropertyArrayValue(int)

Gets a specified value from the custom property iterator array.

getPropertyPath()

Gets the path of properties taken to get to the custom property to iterate over.

getResultListener()

Gets the result listener where results will be sent.

getResultProducer()

Get the result producer used for the current experiment.

getRunLower()

Get the lower run number for the experiment.

getRunUpper()

Get the upper run number for the experiment.

getUsePropertyIterator()

Gets whether the custom property iterator should be used.

hasMoreIterations()

Returns true if there are more iterations to carry out in the experiment.

initialize()

Prepares an experiment for running, initializing current iterator settings.

listOptions()

Returns an enumeration describing the available options.

main(String[])

Configures/Runs the Experiment from the command line.

nextIteration()

Carries out the next iteration of the experiment.

postProcess()

Signals that the experiment is finished running, so that cleanup can be done.

runExperiment()

Runs all iterations of the experiment, continuing past errors.

setNotes(String)

Set the user notes.

setOptions(String[])

Parses a given list of options.

setPropertyArray(Object)

Sets the array of values to set the custom property to.

setPropertyPath(PropertyNode[])

Sets the path of properties taken to get to the custom property to iterate over.

setResultListener(ResultListener)

Sets the result listener where results will be sent.

setResultProducer(ResultProducer)

Set the result producer used for the current experiment.

setRunLower(int)

Set the lower run number for the experiment.

setRunUpper(int)

Set the upper run number for the experiment.

setUsePropertyIterator(boolean)

Sets whether the custom property iterator should be used.

toString()

Gets a string representation of the experiment configuration.

 public Experiment()

 public boolean getUsePropertyIterator()

Gets whether the custom property iterator should be used.

Returns:

true if so

 public void setUsePropertyIterator(boolean newUsePropertyIterator)

Sets whether the custom property iterator should be used.

Parameters:

newUsePropertyIterator - true if so

 public PropertyNode[] getPropertyPath()

Gets the path of properties taken to get to the custom property to iterate over.

Returns:

an array of PropertyNodes

 public void setPropertyPath(PropertyNode newPropertyPath[])

Sets the path of properties taken to get to the custom property to iterate over.

 public void setPropertyArray(Object newPropArray)

Sets the array of values to set the custom property to.

Parameters:

newPropArray - a value of type Object which should be an array of the appropriate values.

 public Object getPropertyArray()

Gets the array of values to set the custom property to.

Returns:

a value of type Object which should be an array of the appropriate values.

 public int getPropertyArrayLength()

Gets the number of custom iterator values that have been defined for the experiment.

Returns:

the number of custom property iterator values.

 public Object getPropertyArrayValue(int index)

Gets a specified value from the custom property iterator array.

Parameters:

index - the index of the value wanted

Returns:

the property array value

 public int getCurrentRunNumber()

When an experiment is running, this returns the current run number.

Returns:

the current run number.

 public int getCurrentDatasetNumber()

When an experiment is running, this returns the current dataset number.

Returns:

the current dataset number.

 public int getCurrentPropertyNumber()

When an experiment is running, this returns the index of the current custom property value.

Returns:

the index of the current custom property value.

 public void initialize() throws Exception

Prepares an experiment for running, initializing current iterator settings.

Throws: Exception

if an error occurs

 public boolean hasMoreIterations()

Returns true if there are more iterations to carry out in the experiment.

Returns:

true if so

 public void nextIteration() throws Exception

Carries out the next iteration of the experiment.

Throws: Exception

if an error occurs

 public void advanceCounters()

Increments iteration counters appropriately.

 public void runExperiment()

Runs all iterations of the experiment, continuing past errors.

 public void postProcess() throws Exception

Signals that the experiment is finished running, so that cleanup can be done.

Throws: Exception

if an error occurs

 public DefaultListModel getDatasets()

Gets the datasets in the experiment.

Returns:

the datasets in the experiment.

 public ResultListener getResultListener()

Gets the result listener where results will be sent.

Returns:

the result listener where results will be sent.

 public void setResultListener(ResultListener newResultListener)

Sets the result listener where results will be sent.

Parameters:

newResultListener - the result listener where results will be sent.

 public ResultProducer getResultProducer()

Get the result producer used for the current experiment.

Returns:

the result producer used for the current experiment.

 public void setResultProducer(ResultProducer newResultProducer)

Set the result producer used for the current experiment.

Parameters:

newResultProducer - result producer to use for the current experiment.

 public int getRunUpper()

Get the upper run number for the experiment.

Returns:

the upper run number for the experiment.

 public void setRunUpper(int newRunUpper)

Set the upper run number for the experiment.

Parameters:

newRunUpper - the upper run number for the experiment.

 public int getRunLower()

Get the lower run number for the experiment.

Returns:

the lower run number for the experiment.

 public void setRunLower(int newRunLower)

Set the lower run number for the experiment.

Parameters:

newRunLower - the lower run number for the experiment.

 public String getNotes()

Get the user notes.

Returns:

User notes associated with the experiment.

 public void setNotes(String newNotes)

Set the user notes.

Parameters:

newNotes - New user notes.

 public Enumeration listOptions()

Returns an enumeration describing the available options.

Returns:

an enumeration of all the available options

 public void setOptions(String options[]) throws Exception

Parses a given list of options. Valid options are:

-L num
The lower run number to start the experiment from. (default 1)

-U num
The upper run number to end the experiment at (inclusive). (default 10)

-T arff_file
The dataset to run the experiment on. (required, may be specified multiple times)

-P class_name
The full class name of a ResultProducer (required). eg: weka.experiment.RandomSplitResultProducer

-D class_name
The full class name of a ResultListener (required). eg: weka.experiment.CSVResultListener

All option after -- will be passed to the result producer (there is currently no way to pass options to the result listener).

Parameters:

options - the list of options as an array of strings

Throws: Exception

if an option is not supported

 public String[] getOptions()

Gets the current settings of the experiment iterator.

Returns:

an array of strings suitable for passing to setOptions

 public String toString()

Gets a string representation of the experiment configuration.

Returns:

a value of type 'String'

Overrides:

toString in class Object

 public static void main(String args[])

Configures/Runs the Experiment from the command line.

Parameters:

args - command line arguments to the Experiment.

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home