meka.experiment.filehandlers

Class AbstractExperimentFileHandler

java.lang.Object

meka.events.LogObject

meka.experiment.filehandlers.AbstractExperimentFileHandler

All Implemented Interfaces:

Serializable, LogSupporter, ExperimentFileHandler, weka.core.OptionHandler

Direct Known Subclasses:

CommandLineSetup, SerializedExperiment

public abstract class AbstractExperimentFileHandler
extends LogObject
implements ExperimentFileHandler

Ancestor for experiment file handler classes.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class meka.events.LogObject

m_Debug, m_LogListeners

Constructor Summary

Constructors

Constructor and Description
AbstractExperimentFileHandler()

Method Summary

Modifier and Type	Method and Description
String[]	getOptions() Returns the options.
abstract String	globalInfo() Description to be displayed in the GUI.
Enumeration<weka.core.Option>	listOptions() Returns an enumeration of all the available options..
abstract Experiment	read(File file) Reads an experiment from disk.
void	setOptions(String[] options) Sets the options.
abstract String	write(Experiment exp, File file) Writes and experiment to disk.

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.experiment.filehandlers.ExperimentFileHandler

getFormatDescription, getFormatExtensions

Methods inherited from interface meka.events.LogSupporter

addLogListener, log, removeLogListener

Constructor Detail

AbstractExperimentFileHandler

public AbstractExperimentFileHandler()

Method Detail

globalInfo

public abstract String globalInfo()

Description to be displayed in the GUI.

Returns:

the description

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 - never

getOptions

public String[] getOptions()

Returns the options.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

the options

read

public abstract Experiment read(File file)

Reads an experiment from disk.

Specified by:

read in interface ExperimentFileHandler

Parameters:

file - the file to load

Returns:

the experiment, null if failed to load

write

public abstract String write(Experiment exp,
                             File file)

Writes and experiment to disk.

Specified by:

write in interface ExperimentFileHandler

Parameters:

exp - the experiment to save

file - the file to save to

Returns:

null if successful, otherwise error message