meka.experiment.evaluationstatistics

Class KeyValuePairs

java.lang.Object

meka.events.LogObject

meka.experiment.evaluationstatistics.AbstractEvaluationStatisticsHandler

meka.experiment.evaluationstatistics.AbstractFileBasedEvaluationStatisticsHandler

meka.experiment.evaluationstatistics.KeyValuePairs

All Implemented Interfaces:

Serializable, FileFormatSupporter, LogSupporter, EvaluationStatisticsHandler, FileBasedEvaluationStatisticsHandler, IncrementalEvaluationStatisticsHandler, OptionalIncrementalEvaluationStatisticsHandler, weka.core.OptionHandler

public class KeyValuePairs
extends AbstractFileBasedEvaluationStatisticsHandler
implements OptionalIncrementalEvaluationStatisticsHandler

Simple plain text format. One statistics object per line, as tab-separated key-value pairs.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CLASSIFIER the key for the classifier.
static String	KEY_RELATION the key for the relation.
protected boolean	m_IncrementalDisabled whether the incremental mode is off.
protected List<EvaluationStatistics>	m_Statistics the statistics so far.

Fields inherited from class meka.experiment.evaluationstatistics.AbstractFileBasedEvaluationStatisticsHandler

m_File

Fields inherited from class meka.events.LogObject

m_Debug, m_LogListeners

Constructor Summary

Constructors

Constructor and Description
KeyValuePairs()

Method Summary

Modifier and Type	Method and Description
String	append(List<EvaluationStatistics> stats) Adds the given statistics.
String	finish() Gets called after the experiment finished.
String	getFormatDescription() Returns the format description.
String[]	getFormatExtensions() Returns the format extension(s).
String[]	getOptions() Returns the options.
String	globalInfo() Description to be displayed in the GUI.
String	incrementalDisabledTipText() Describes this property.
String	initialize() Initializes the handler.
boolean	isIncrementalDisabled() Returns whether incremental mode is turned off.
boolean	isThreadSafe() Returns whether the handler is threadsafe.
Enumeration<weka.core.Option>	listOptions() Returns an enumeration of all the available options.
List<EvaluationStatistics>	read() Reads the statistics.
boolean	requires(MultiLabelClassifier classifier, weka.core.Instances dataset) Checks whether the specified combination of classifier and dataset is required for evaluation or already present from previous evaluation.
List<EvaluationStatistics>	retrieve(MultiLabelClassifier classifier, weka.core.Instances dataset) Retrieves the statis for the specified combination of classifier and dataset.
void	setIncrementalDisabled(boolean value) Sets whether incremental model is turned off.
void	setOptions(String[] options) Sets the options.
boolean	supportsIncrementalUpdate() Returns whether the handler supports incremental write.
String	write(List<EvaluationStatistics> stats) Stores the given statistics.

Methods inherited from class meka.experiment.evaluationstatistics.AbstractFileBasedEvaluationStatisticsHandler

fileTipText, getDefaultFile, getFile, setFile

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

KEY_CLASSIFIER

public static final String KEY_CLASSIFIER

the key for the classifier.

See Also:

Constant Field Values

KEY_RELATION

public static final String KEY_RELATION

the key for the relation.

See Also:

Constant Field Values

m_Statistics

protected List<EvaluationStatistics> m_Statistics

the statistics so far.

m_IncrementalDisabled

protected boolean m_IncrementalDisabled

whether the incremental mode is off.

Constructor Detail

KeyValuePairs

public KeyValuePairs()

Method Detail

globalInfo

public String globalInfo()

Description to be displayed in the GUI.

Specified by:

globalInfo in class AbstractEvaluationStatisticsHandler

Returns:

the description

getFormatDescription

public String getFormatDescription()

Returns the format description.

Specified by:

getFormatDescription in interface FileFormatSupporter

Specified by:

getFormatDescription in interface FileBasedEvaluationStatisticsHandler

Returns:

the file format

getFormatExtensions

public String[] getFormatExtensions()

Returns the format extension(s).

Specified by:

getFormatExtensions in interface FileFormatSupporter

Specified by:

getFormatExtensions in interface FileBasedEvaluationStatisticsHandler

Returns:

the extension(s) (incl dot)

setIncrementalDisabled

public void setIncrementalDisabled(boolean value)

Sets whether incremental model is turned off.

Specified by:

setIncrementalDisabled in interface OptionalIncrementalEvaluationStatisticsHandler

Parameters:

value - true to turn off incremental mode

isIncrementalDisabled

public boolean isIncrementalDisabled()

Returns whether incremental mode is turned off.

Specified by:

isIncrementalDisabled in interface OptionalIncrementalEvaluationStatisticsHandler

Returns:

true if incremental mode is pff

incrementalDisabledTipText

public String incrementalDisabledTipText()

Describes this property.

Specified by:

incrementalDisabledTipText in interface OptionalIncrementalEvaluationStatisticsHandler

Returns:

the description

isThreadSafe

public boolean isThreadSafe()

Returns whether the handler is threadsafe.

Specified by:

isThreadSafe in interface EvaluationStatisticsHandler

Overrides:

isThreadSafe in class AbstractEvaluationStatisticsHandler

Returns:

true if threadsafe

supportsIncrementalUpdate

public boolean supportsIncrementalUpdate()

Returns whether the handler supports incremental write.

Specified by:

supportsIncrementalUpdate in interface IncrementalEvaluationStatisticsHandler

Returns:

true if supported

listOptions

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

Returns an enumeration of all the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class AbstractFileBasedEvaluationStatisticsHandler

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

Overrides:

setOptions in class AbstractFileBasedEvaluationStatisticsHandler

Parameters:

options - the options

Throws:

Exception - never

getOptions

public String[] getOptions()

Returns the options.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class AbstractFileBasedEvaluationStatisticsHandler

Returns:

the options

initialize

public String initialize()

Initializes the handler.

Specified by:

initialize in interface EvaluationStatisticsHandler

Overrides:

initialize in class AbstractFileBasedEvaluationStatisticsHandler

Returns:

null if successfully initialized, otherwise error message

read

public List<EvaluationStatistics> read()

Reads the statistics.

Specified by:

read in interface EvaluationStatisticsHandler

Returns:

the statistics that were read

requires

public boolean requires(MultiLabelClassifier classifier,
                        weka.core.Instances dataset)

Checks whether the specified combination of classifier and dataset is required for evaluation or already present from previous evaluation.

Specified by:

requires in interface IncrementalEvaluationStatisticsHandler

Parameters:

classifier - the classifier to check

dataset - the dataset to check

Returns:

true if it needs evaluating

retrieve

public List<EvaluationStatistics> retrieve(MultiLabelClassifier classifier,
                                           weka.core.Instances dataset)

Retrieves the statis for the specified combination of classifier and dataset.

Specified by:

retrieve in interface IncrementalEvaluationStatisticsHandler

Parameters:

classifier - the classifier to check

dataset - the dataset to check

Returns:

the stats, null if not available

append

public String append(List<EvaluationStatistics> stats)

Adds the given statistics.

Specified by:

append in interface IncrementalEvaluationStatisticsHandler

Parameters:

stats - the statistics to store

Returns:

null if successfully stored, otherwise error message

write

public String write(List<EvaluationStatistics> stats)

Stores the given statistics.

Specified by:

write in interface EvaluationStatisticsHandler

Parameters:

stats - the statistics to store

Returns:

null if successfully stored, otherwise error message

finish

public String finish()

Gets called after the experiment finished.

Specified by:

finish in interface EvaluationStatisticsHandler

Overrides:

finish in class AbstractEvaluationStatisticsHandler

Returns:

null if successfully finished, otherwise error message