meka.experiment

Class DefaultExperiment

java.lang.Object

meka.events.LogObject

meka.experiment.DefaultExperiment

All Implemented Interfaces:

Serializable, LogSupporter, Experiment, weka.core.OptionHandler

public class DefaultExperiment
extends LogObject
implements Experiment

Default experiment which executes experiments on the local machine.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MultiLabelClassifier[]	m_Classifiers the classifiers to evaluate.
protected DatasetProvider	m_DatasetProvider the dataset provider.
protected Evaluator	m_Evaluator the evaluator.
protected HashSet<ExecutionStageListener>	m_ExecutionStageListeners the listeners for execution stages.
protected boolean	m_Initializing whether the experiment is initializing.
protected HashSet<IterationNotificationListener>	m_IterationNotficationListeners the listeners for iterations.
protected String	m_Notes the notes.
protected boolean	m_Running whether the experiment is running.
protected List<EvaluationStatistics>	m_Statistics the collected statistics.
protected EvaluationStatisticsHandler	m_StatisticsHandler the statistics handler.
protected HashSet<StatisticsNotificationListener>	m_StatisticsNotificationListeners the listeners for statistics.
protected boolean	m_Stopping whether the experiment is stopping.

Fields inherited from class meka.events.LogObject

m_Debug, m_LogListeners

Constructor Summary

Constructors

Constructor and Description
DefaultExperiment()

Method Summary

Modifier and Type	Method and Description
void	addExecutionStageListener(ExecutionStageListener l) Adds the execution stage listener.
void	addIterationNotificationListener(IterationNotificationListener l) Adds the iteration listener.
void	addStatisticsNotificationListener(StatisticsNotificationListener l) Adds the statistics listener.
String	classifiersTipText() Describes this property.
String	datasetProviderTipText() Describes this property.
String	evaluatorTipText() Describes this property.
String	finish() Finishes the experiment.
MultiLabelClassifier[]	getClassifiers() Returns the classifiers to be evaluated.
DatasetProvider	getDatasetProvider() Returns the dataset provider in use.
protected DatasetProvider	getDefaultDatasetProvider() Returns the default dataset provider.
protected Evaluator	getDefaultEvaluator() Returns the default evaluator to use.
protected EvaluationStatisticsHandler	getDefaultStatisticsHandler() Returns the default statistics handler.
Evaluator	getEvaluator() Returns the evaluator in use.
String	getNotes() Returns the notes.
String[]	getOptions() Returns the options.
List<EvaluationStatistics>	getStatistics() Returns the current statistics.
EvaluationStatisticsHandler	getStatisticsHandler() Returns the statistics handler.
protected String	handleError(Object source, String msg) Adds the source's class name to the message if not null.
String	initialize() Initializes the experiment.
boolean	isInitializing() Returns whether the experiment is initializing.
boolean	isRunning() Returns whether the experiment is running.
boolean	isStopping() Returns whether the experiment is stopping.
Enumeration<weka.core.Option>	listOptions() Returns an enumeration of all the available options..
String	notesTipText() Describes this property.
protected void	notifyExecutionStageListeners(ExecutionStageEvent.Stage stage) Notifies all listeners of a new execution stage.
protected void	notifyIterationNotificationListeners(MultiLabelClassifier classifier, weka.core.Instances dataset) Notifies all listeners of a new classifier/dataset combination.
protected void	notifyStatisticsNotificationListeners(List<EvaluationStatistics> stats) Notifies all listeners of a new classifier/dataset combination.
void	removeExecutionStageListener(ExecutionStageListener l) Removes the execution stage listener.
void	removeIterationNotificationListener(IterationNotificationListener l) Removes the iteration listener.
void	removeStatisticsNotificationListener(StatisticsNotificationListener l) Removes the statistics listener.
String	run() Runs the experiment.
void	setClassifiers(MultiLabelClassifier[] value) Sets the classifiers to be evaluated.
void	setDatasetProvider(DatasetProvider value) Sets the dataset provider to use.
void	setEvaluator(Evaluator value) Sets the evaluator to use.
void	setNotes(String value) Sets the notes.
void	setOptions(String[] options) Sets the options.
void	setStatisticsHandler(EvaluationStatisticsHandler value) Sets the statistics handler.
String	statisticsHandlerTipText() Describes this property.
void	stop() Stops the experiment if running.

Methods inherited from class meka.events.LogObject

addLogListener, debug, getLogListeners, handleException, log, removeLogListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface meka.events.LogSupporter

addLogListener, log, removeLogListener

Field Detail

m_Notes

protected String m_Notes

the notes.

m_Classifiers

protected MultiLabelClassifier[] m_Classifiers

the classifiers to evaluate.

m_DatasetProvider

protected DatasetProvider m_DatasetProvider

the dataset provider.

m_Evaluator

protected Evaluator m_Evaluator

the evaluator.

m_StatisticsHandler

protected EvaluationStatisticsHandler m_StatisticsHandler

the statistics handler.

m_Initializing

protected boolean m_Initializing

whether the experiment is initializing.

m_Running

protected boolean m_Running

whether the experiment is running.

m_Stopping

protected boolean m_Stopping

whether the experiment is stopping.

m_ExecutionStageListeners

protected transient HashSet<ExecutionStageListener> m_ExecutionStageListeners

the listeners for execution stages.

m_IterationNotficationListeners

protected transient HashSet<IterationNotificationListener> m_IterationNotficationListeners

the listeners for iterations.

m_StatisticsNotificationListeners

protected transient HashSet<StatisticsNotificationListener> m_StatisticsNotificationListeners

the listeners for statistics.

m_Statistics

protected List<EvaluationStatistics> m_Statistics

the collected statistics.

Constructor Detail

DefaultExperiment

public DefaultExperiment()

Method Detail

setNotes

public void setNotes(String value)

Sets the notes.

Specified by:

setNotes in interface Experiment

Parameters:

value - the notes

getNotes

public String getNotes()

Returns the notes.

Specified by:

getNotes in interface Experiment

Returns:

the notes

notesTipText

public String notesTipText()

Describes this property.

Returns:

the description

setClassifiers

public void setClassifiers(MultiLabelClassifier[] value)

Sets the classifiers to be evaluated.

Specified by:

setClassifiers in interface Experiment

Parameters:

value - the classifiers

getClassifiers

public MultiLabelClassifier[] getClassifiers()

Returns the classifiers to be evaluated.

Specified by:

getClassifiers in interface Experiment

Returns:

the classifiers

classifiersTipText

public String classifiersTipText()

Describes this property.

Specified by:

classifiersTipText in interface Experiment

Returns:

the description

getDefaultDatasetProvider

protected DatasetProvider getDefaultDatasetProvider()

Returns the default dataset provider.

Returns:

the default

setDatasetProvider

public void setDatasetProvider(DatasetProvider value)

Sets the dataset provider to use.

Specified by:

setDatasetProvider in interface Experiment

Parameters:

value - the provider

getDatasetProvider

public DatasetProvider getDatasetProvider()

Returns the dataset provider in use.

Specified by:

getDatasetProvider in interface Experiment

Returns:

the provider

datasetProviderTipText

public String datasetProviderTipText()

Describes this property.

Specified by:

datasetProviderTipText in interface Experiment

Returns:

the description

getDefaultEvaluator

protected Evaluator getDefaultEvaluator()

Returns the default evaluator to use.

Returns:

the default

setEvaluator

public void setEvaluator(Evaluator value)

Sets the evaluator to use.

Specified by:

setEvaluator in interface Experiment

Parameters:

value - the evaluator

getEvaluator

public Evaluator getEvaluator()

Returns the evaluator in use.

Specified by:

getEvaluator in interface Experiment

Returns:

the evaluator

evaluatorTipText

public String evaluatorTipText()

Describes this property.

Specified by:

evaluatorTipText in interface Experiment

Returns:

the description

setStatisticsHandler

public void setStatisticsHandler(EvaluationStatisticsHandler value)

Sets the statistics handler.

Specified by:

setStatisticsHandler in interface Experiment

Parameters:

value - the handler

getDefaultStatisticsHandler

protected EvaluationStatisticsHandler getDefaultStatisticsHandler()

Returns the default statistics handler.

Returns:

the default

getStatisticsHandler

public EvaluationStatisticsHandler getStatisticsHandler()

Returns the statistics handler.

Specified by:

getStatisticsHandler in interface Experiment

Returns:

the handler

statisticsHandlerTipText

public String statisticsHandlerTipText()

Describes this property.

Specified by:

statisticsHandlerTipText in interface Experiment

Returns:

the description

addExecutionStageListener

public void addExecutionStageListener(ExecutionStageListener l)

Adds the execution stage listener.

Specified by:

addExecutionStageListener in interface Experiment

Parameters:

l - the listener to add

removeExecutionStageListener

public void removeExecutionStageListener(ExecutionStageListener l)

Removes the execution stage listener.

Specified by:

removeExecutionStageListener in interface Experiment

Parameters:

l - the listener to remove

notifyExecutionStageListeners

protected void notifyExecutionStageListeners(ExecutionStageEvent.Stage stage)

Notifies all listeners of a new execution stage.

Parameters:

stage - the new stage

addIterationNotificationListener

public void addIterationNotificationListener(IterationNotificationListener l)

Adds the iteration listener.

Specified by:

addIterationNotificationListener in interface Experiment

Parameters:

l - the listener to add

removeIterationNotificationListener

public void removeIterationNotificationListener(IterationNotificationListener l)

Removes the iteration listener.

Specified by:

removeIterationNotificationListener in interface Experiment

Parameters:

l - the listener to remove

notifyIterationNotificationListeners

protected void notifyIterationNotificationListeners(MultiLabelClassifier classifier,
                                                    weka.core.Instances dataset)

Notifies all listeners of a new classifier/dataset combination.

Parameters:

classifier - the classifier

dataset - the dataset

addStatisticsNotificationListener

public void addStatisticsNotificationListener(StatisticsNotificationListener l)

Adds the statistics listener.

Specified by:

addStatisticsNotificationListener in interface Experiment

Parameters:

l - the listener to add

removeStatisticsNotificationListener

public void removeStatisticsNotificationListener(StatisticsNotificationListener l)

Removes the statistics listener.

Specified by:

removeStatisticsNotificationListener in interface Experiment

Parameters:

l - the listener to remove

notifyStatisticsNotificationListeners

protected void notifyStatisticsNotificationListeners(List<EvaluationStatistics> stats)

Notifies all listeners of a new classifier/dataset combination.

Parameters:

stats - the statistics

listOptions

public Enumeration<weka.core.Option> listOptions()

Returns an enumeration of all the available options..

Specified by:

listOptions in interface weka.core.OptionHandler

Returns:

an enumeration of all available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Sets the options.

Specified by:

setOptions in interface weka.core.OptionHandler

Parameters:

options - the options

Throws:

Exception - if parsing fails

getOptions

public String[] getOptions()

Returns the options.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

the options

handleError

protected String handleError(Object source,
                             String msg)

Adds the source's class name to the message if not null.

Parameters:

source - the source

msg - the error message, can be null

Returns:

null if no error message, otherwise enriched message

initialize

public String initialize()

Initializes the experiment.

Specified by:

initialize in interface Experiment

Returns:

null if successfully initialized, otherwise error message

isInitializing

public boolean isInitializing()

Returns whether the experiment is initializing.

Specified by:

isInitializing in interface Experiment

Returns:

true if initializing

run

public String run()

Runs the experiment.

Specified by:

run in interface Experiment

Returns:

null if successfully run, otherwise error message

isRunning

public boolean isRunning()

Returns whether the experiment is running.

Specified by:

isRunning in interface Experiment

Returns:

true if running

stop

public void stop()

Stops the experiment if running.

Specified by:

stop in interface Experiment

isStopping

public boolean isStopping()

Returns whether the experiment is stopping.

Specified by:

isStopping in interface Experiment

Returns:

true if stopping

finish

public String finish()

Finishes the experiment.

Specified by:

finish in interface Experiment

Returns:

null if successfully finished, otherwise error message

getStatistics

public List<EvaluationStatistics> getStatistics()

Returns the current statistics.

Specified by:

getStatistics in interface Experiment

Returns:

the statistics, if any