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 java.lang.Object
implements java.io.Serializable, OptionHandler
Holds all the necessary configuration information for a standard type experiment. This object is able to be serialized for storage on disk.

Version:
$Revision: 1.15 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Variable Index

 o FILE_EXTENSION
The filename extension that should be used for experiment files

Constructor Index

 o Experiment()
 

Method Index

 o advanceCounters()
Increments iteration counters appropriately.
 o classFirst(boolean)
Sets whether the first attribute is treated as the class for all datasets involved in the experiment.
 o getAdvanceDataSetFirst()
Get the value of m_DataSetFirstFirst.
 o getCurrentDatasetNumber()
When an experiment is running, this returns the current dataset number.
 o getCurrentPropertyNumber()
When an experiment is running, this returns the index of the current custom property value.
 o getCurrentRunNumber()
When an experiment is running, this returns the current run number.
 o getDatasets()
Gets the datasets in the experiment.
 o getNotes()
Get the user notes.
 o getOptions()
Gets the current settings of the experiment iterator.
 o getPropertyArray()
Gets the array of values to set the custom property to.
 o getPropertyArrayLength()
Gets the number of custom iterator values that have been defined for the experiment.
 o getPropertyArrayValue(int)
Gets a specified value from the custom property iterator array.
 o getPropertyPath()
Gets the path of properties taken to get to the custom property to iterate over.
 o getResultListener()
Gets the result listener where results will be sent.
 o getResultProducer()
Get the result producer used for the current experiment.
 o getRunLower()
Get the lower run number for the experiment.
 o getRunUpper()
Get the upper run number for the experiment.
 o getUsePropertyIterator()
Gets whether the custom property iterator should be used.
 o hasMoreIterations()
Returns true if there are more iterations to carry out in the experiment.
 o initialize()
Prepares an experiment for running, initializing current iterator settings.
 o listOptions()
Returns an enumeration describing the available options.
 o main(String[])
Configures/Runs the Experiment from the command line.
 o nextIteration()
Carries out the next iteration of the experiment.
 o postProcess()
Signals that the experiment is finished running, so that cleanup can be done.
 o runExperiment()
Runs all iterations of the experiment, continuing past errors.
 o setAdvanceDataSetFirst(boolean)
Set the value of m_AdvanceDataSetFirst.
 o setDatasets(DefaultListModel)
Set the datasets to use in the experiment
 o setNotes(String)
Set the user notes.
 o setOptions(String[])
Parses a given list of options.
 o setPropertyArray(Object)
Sets the array of values to set the custom property to.
 o setPropertyPath(PropertyNode[])
Sets the path of properties taken to get to the custom property to iterate over.
 o setResultListener(ResultListener)
Sets the result listener where results will be sent.
 o setResultProducer(ResultProducer)
Set the result producer used for the current experiment.
 o setRunLower(int)
Set the lower run number for the experiment.
 o setRunUpper(int)
Set the upper run number for the experiment.
 o setUsePropertyIterator(boolean)
Sets whether the custom property iterator should be used.
 o toString()
Gets a string representation of the experiment configuration.

Field Detail

 o FILE_EXTENSION
public static java.lang.String FILE_EXTENSION
          The filename extension that should be used for experiment files

Constructor Detail

 o Experiment
public Experiment()

Method Detail

 o classFirst
public void classFirst(boolean flag)
          Sets whether the first attribute is treated as the class for all datasets involved in the experiment. This information is not output with the result of the experiments!
 o getAdvanceDataSetFirst
public boolean getAdvanceDataSetFirst()
          Get the value of m_DataSetFirstFirst.
Returns:
Value of m_DataSetFirstFirst.
 o setAdvanceDataSetFirst
public void setAdvanceDataSetFirst(boolean newAdvanceDataSetFirst)
          Set the value of m_AdvanceDataSetFirst.
Parameters:
newm_AdvanceDataSetFirst - Value to assign to m_AdvanceRunFirst.
 o getUsePropertyIterator
public boolean getUsePropertyIterator()
          Gets whether the custom property iterator should be used.
Returns:
true if so
 o setUsePropertyIterator
public void setUsePropertyIterator(boolean newUsePropertyIterator)
          Sets whether the custom property iterator should be used.
Parameters:
newUsePropertyIterator - true if so
 o getPropertyPath
public PropertyNode[] getPropertyPath()
          Gets the path of properties taken to get to the custom property to iterate over.
Returns:
an array of PropertyNodes
 o setPropertyPath
public void setPropertyPath(PropertyNode newPropertyPath[])
          Sets the path of properties taken to get to the custom property to iterate over.
 o setPropertyArray
public void setPropertyArray(java.lang.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.
 o getPropertyArray
public java.lang.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.
 o getPropertyArrayLength
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.
 o getPropertyArrayValue
public java.lang.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
 o getCurrentRunNumber
public int getCurrentRunNumber()
          When an experiment is running, this returns the current run number.
Returns:
the current run number.
 o getCurrentDatasetNumber
public int getCurrentDatasetNumber()
          When an experiment is running, this returns the current dataset number.
Returns:
the current dataset number.
 o getCurrentPropertyNumber
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.
 o initialize
public void initialize() throws java.lang.Exception
          Prepares an experiment for running, initializing current iterator settings.
Throws:
java.lang.Exception - if an error occurs
 o hasMoreIterations
public boolean hasMoreIterations()
          Returns true if there are more iterations to carry out in the experiment.
Returns:
true if so
 o nextIteration
public void nextIteration() throws java.lang.Exception
          Carries out the next iteration of the experiment.
Throws:
java.lang.Exception - if an error occurs
 o advanceCounters
public void advanceCounters()
          Increments iteration counters appropriately.
 o runExperiment
public void runExperiment()
          Runs all iterations of the experiment, continuing past errors.
 o postProcess
public void postProcess() throws java.lang.Exception
          Signals that the experiment is finished running, so that cleanup can be done.
Throws:
java.lang.Exception - if an error occurs
 o getDatasets
public javax.swing.DefaultListModel getDatasets()
          Gets the datasets in the experiment.
Returns:
the datasets in the experiment.
 o setDatasets
public void setDatasets(javax.swing.DefaultListModel ds)
          Set the datasets to use in the experiment
Parameters:
ds - the list of datasets to use
 o getResultListener
public ResultListener getResultListener()
          Gets the result listener where results will be sent.
Returns:
the result listener where results will be sent.
 o setResultListener
public void setResultListener(ResultListener newResultListener)
          Sets the result listener where results will be sent.
Parameters:
newResultListener - the result listener where results will be sent.
 o getResultProducer
public ResultProducer getResultProducer()
          Get the result producer used for the current experiment.
Returns:
the result producer used for the current experiment.
 o setResultProducer
public void setResultProducer(ResultProducer newResultProducer)
          Set the result producer used for the current experiment.
Parameters:
newResultProducer - result producer to use for the current experiment.
 o getRunUpper
public int getRunUpper()
          Get the upper run number for the experiment.
Returns:
the upper run number for the experiment.
 o setRunUpper
public void setRunUpper(int newRunUpper)
          Set the upper run number for the experiment.
Parameters:
newRunUpper - the upper run number for the experiment.
 o getRunLower
public int getRunLower()
          Get the lower run number for the experiment.
Returns:
the lower run number for the experiment.
 o setRunLower
public void setRunLower(int newRunLower)
          Set the lower run number for the experiment.
Parameters:
newRunLower - the lower run number for the experiment.
 o getNotes
public java.lang.String getNotes()
          Get the user notes.
Returns:
User notes associated with the experiment.
 o setNotes
public void setNotes(java.lang.String newNotes)
          Set the user notes.
Parameters:
newNotes - New user notes.
 o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options
 o setOptions
public void setOptions(java.lang.String options[]) throws java.lang.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 followed by any options. If options are supplied then full string must be enclosed in quotes. (required). eg: "weka.experiment.CSVResultListener -O outfile.csv"

All option after -- will be passed to the result producer.

Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported
 o getOptions
public java.lang.String[] getOptions()
          Gets the current settings of the experiment iterator.
Returns:
an array of strings suitable for passing to setOptions
 o toString
public java.lang.String toString()
          Gets a string representation of the experiment configuration.
Returns:
a value of type 'String'
Overrides:
toString in class java.lang.Object
 o main
public static void main(java.lang.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