SimpleAggregate (meka 1.9.1 API)

java.lang.Object
- meka.events.LogObject
- - meka.experiment.statisticsexporters.AbstractEvaluationStatisticsExporter
  - - meka.experiment.statisticsexporters.AbstractMetaEvaluationStatisticsExporter
    - - meka.experiment.statisticsexporters.SimpleAggregate

All Implemented Interfaces:

Serializable, LogSupporter, AggregatedEvaluationStatisticsExporter, EvaluationStatisticsExporter, weka.core.OptionHandler
```
public class SimpleAggregate
extends AbstractMetaEvaluationStatisticsExporter
implements AggregatedEvaluationStatisticsExporter
```
Simple aggregator of statistics.

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 String`	`m_AggregationKeys` the aggregation keys.
`protected boolean`	`m_SkipCount` whether to skip the count.
`protected boolean`	`m_SkipMean` whether to skip the mean.
`protected boolean`	`m_SkipStdDev` whether to skip the stdev.
`protected String`	`m_SuffixCount` the count suffix.
`protected String`	`m_SuffixMean` the mean suffix.
`protected String`	`m_SuffixStdDev` the stdev suffix.
`static String`	`SUFFIX_COUNT` the suffix for the count.
`static String`	`SUFFIX_MEAN` the suffix for the mean.
`static String`	`SUFFIX_STDEV` the suffix for the stdev.

Fields inherited from class meka.experiment.statisticsexporters.AbstractMetaEvaluationStatisticsExporter
m_Exporter

Fields inherited from class meka.events.LogObject
m_Debug, m_LogListeners

Constructor Summary

Constructors
Constructor and Description

SimpleAggregate()

Constructors
Constructor and Description
`SimpleAggregate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<EvaluationStatistics>`	`aggregate(List<EvaluationStatistics> stats)` Aggregates the statistics and returns these.
`String`	`aggregationKeysTipText()` Describes this property.
`protected EvaluationStatistics`	`doAggregate(List<EvaluationStatistics> stats)` Calculates the actual aggregates.
`protected String`	`doExport(List<EvaluationStatistics> stats)` Exports the statistics.
`String`	`getAggregationKeys()` Returns the blank-separated list of keys used for aggregating.
`protected String`	`getDefaultAggregationKeys()` Returns the default keys used for aggregation.
`protected EvaluationStatisticsExporter`	`getDefaultExporter()` Returns the default exporter to use.
`protected String`	`getDefaultSuffixCount()` Returns the default suffix for the count.
`protected String`	`getDefaultSuffixMean()` Returns the default suffix for the mean.
`protected String`	`getDefaultSuffixStdDev()` Returns the default suffix for the stddev.
`String[]`	`getOptions()` Returns the options.
`boolean`	`getSkipCount()` Returns whether to skip the count.
`boolean`	`getSkipMean()` Returns whether to skip the mean.
`boolean`	`getSkipStdDev()` Returns whether to skip the stdDev.
`String`	`getSuffixCount()` Returns the suffix for the count.
`String`	`getSuffixMean()` Returns the suffix for the mean.
`String`	`getSuffixStdDev()` Returns the suffix for the stddev.
`String`	`globalInfo()` Description to be displayed in the GUI.
`Enumeration<weka.core.Option>`	`listOptions()` Returns an enumeration of all the available options..
`void`	`setAggregationKeys(String keys)` Sets the blank-separated list of keys to use for aggregating.
`void`	`setOptions(String[] options)` Sets the options.
`void`	`setSkipCount(boolean value)` Sets whether to skip the count.
`void`	`setSkipMean(boolean value)` Sets whether to skip the mean.
`void`	`setSkipStdDev(boolean value)` Sets whether to skip the stdDev.
`void`	`setSuffixCount(String value)` Sets the suffix for the count.
`void`	`setSuffixMean(String value)` Sets the suffix for the mean.
`void`	`setSuffixStdDev(String value)` Sets the suffix for the stddev.
`String`	`skipCountTipText()` Describes this property.
`String`	`skipMeanTipText()` Describes this property.
`String`	`skipStdDevTipText()` Describes this property.
`String`	`suffixCountTipText()` Describes this property.
`String`	`suffixMeanTipText()` Describes this property.
`String`	`suffixStdDevTipText()` Describes this property.

Methods inherited from class meka.experiment.statisticsexporters.AbstractMetaEvaluationStatisticsExporter
addLogListener, exporterTipText, getExporter, removeLogListener, setExporter

Methods inherited from class meka.experiment.statisticsexporters.AbstractEvaluationStatisticsExporter
export

Methods inherited from class meka.events.LogObject
debug, getLogListeners, handleException, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface meka.experiment.statisticsexporters.EvaluationStatisticsExporter
export

Methods inherited from interface meka.events.LogSupporter
addLogListener, log, removeLogListener

- Field Detail
  - SUFFIX_COUNT
```
public static final String SUFFIX_COUNT
```
    the suffix for the count.
    
    See Also:
    
    Constant Field Values
  - SUFFIX_MEAN
```
public static final String SUFFIX_MEAN
```
    the suffix for the mean.
    
    See Also:
    
    Constant Field Values
  - SUFFIX_STDEV
```
public static final String SUFFIX_STDEV
```
    the suffix for the stdev.
    
    See Also:
    
    Constant Field Values
  - m_AggregationKeys
```
protected String m_AggregationKeys
```
    the aggregation keys.
  - m_SuffixCount
```
protected String m_SuffixCount
```
    the count suffix.
  - m_SuffixMean
```
protected String m_SuffixMean
```
    the mean suffix.
  - m_SuffixStdDev
```
protected String m_SuffixStdDev
```
    the stdev suffix.
  - m_SkipCount
```
protected boolean m_SkipCount
```
    whether to skip the count.
  - m_SkipMean
```
protected boolean m_SkipMean
```
    whether to skip the mean.
  - m_SkipStdDev
```
protected boolean m_SkipStdDev
```
    whether to skip the stdev.
- Constructor Detail
  - SimpleAggregate
```
public SimpleAggregate()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Description to be displayed in the GUI.
    
    Specified by:
    
    globalInfo in class AbstractEvaluationStatisticsExporter
    
    Returns:
    
    the description
  - getDefaultExporter
```
protected EvaluationStatisticsExporter getDefaultExporter()
```
    Returns the default exporter to use.
    
    Specified by:
    
    getDefaultExporter in class AbstractMetaEvaluationStatisticsExporter
    
    Returns:
    
    the default
  - getDefaultAggregationKeys
```
protected String getDefaultAggregationKeys()
```
    Returns the default keys used for aggregation.
    
    Returns:
    
    the default
  - setAggregationKeys
```
public void setAggregationKeys(String keys)
```
    Sets the blank-separated list of keys to use for aggregating.
    
    Specified by:
    
    setAggregationKeys in interface AggregatedEvaluationStatisticsExporter
    
    Parameters:
    
    keys - the keys (blank-separated)
  - getAggregationKeys
```
public String getAggregationKeys()
```
    Returns the blank-separated list of keys used for aggregating.
    
    Specified by:
    
    getAggregationKeys in interface AggregatedEvaluationStatisticsExporter
    
    Returns:
    
    the keys (blank-separated)
  - aggregationKeysTipText
```
public String aggregationKeysTipText()
```
    Describes this property.
    
    Specified by:
    
    aggregationKeysTipText in interface AggregatedEvaluationStatisticsExporter
    
    Returns:
    
    the description
  - getDefaultSuffixCount
```
protected String getDefaultSuffixCount()
```
    Returns the default suffix for the count.
    
    Returns:
    
    the default
  - setSuffixCount
```
public void setSuffixCount(String value)
```
    Sets the suffix for the count.
    
    Parameters:
    
    value - the suffix
  - getSuffixCount
```
public String getSuffixCount()
```
    Returns the suffix for the count.
    
    Returns:
    
    the suffix
  - suffixCountTipText
```
public String suffixCountTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - getDefaultSuffixMean
```
protected String getDefaultSuffixMean()
```
    Returns the default suffix for the mean.
    
    Returns:
    
    the default
  - setSuffixMean
```
public void setSuffixMean(String value)
```
    Sets the suffix for the mean.
    
    Parameters:
    
    value - the suffix
  - getSuffixMean
```
public String getSuffixMean()
```
    Returns the suffix for the mean.
    
    Returns:
    
    the suffix
  - suffixMeanTipText
```
public String suffixMeanTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - getDefaultSuffixStdDev
```
protected String getDefaultSuffixStdDev()
```
    Returns the default suffix for the stddev.
    
    Returns:
    
    the default
  - setSuffixStdDev
```
public void setSuffixStdDev(String value)
```
    Sets the suffix for the stddev.
    
    Parameters:
    
    value - the suffix
  - getSuffixStdDev
```
public String getSuffixStdDev()
```
    Returns the suffix for the stddev.
    
    Returns:
    
    the suffix
  - suffixStdDevTipText
```
public String suffixStdDevTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - setSkipCount
```
public void setSkipCount(boolean value)
```
    Sets whether to skip the count.
    
    Parameters:
    
    value - true if to skip
  - getSkipCount
```
public boolean getSkipCount()
```
    Returns whether to skip the count.
    
    Returns:
    
    true if to skip
  - skipCountTipText
```
public String skipCountTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - setSkipMean
```
public void setSkipMean(boolean value)
```
    Sets whether to skip the mean.
    
    Parameters:
    
    value - true if to skip
  - getSkipMean
```
public boolean getSkipMean()
```
    Returns whether to skip the mean.
    
    Returns:
    
    true if to skip
  - skipMeanTipText
```
public String skipMeanTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - setSkipStdDev
```
public void setSkipStdDev(boolean value)
```
    Sets whether to skip the stdDev.
    
    Parameters:
    
    value - true if to skip
  - getSkipStdDev
```
public boolean getSkipStdDev()
```
    Returns whether to skip the stdDev.
    
    Returns:
    
    true if to skip
  - skipStdDevTipText
```
public String skipStdDevTipText()
```
    Describes this property.
    
    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
    
    Overrides:
    
    listOptions in class AbstractMetaEvaluationStatisticsExporter
    
    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 AbstractMetaEvaluationStatisticsExporter
    
    Parameters:
    
    options - the options to parse
    
    Throws:
    
    Exception - if parsing fails
  - getOptions
```
public String[] getOptions()
```
    Returns the options.
    
    Specified by:
    
    getOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    getOptions in class AbstractMetaEvaluationStatisticsExporter
    
    Returns:
    
    the current options
  - doAggregate
```
protected EvaluationStatistics doAggregate(List<EvaluationStatistics> stats)
```
    Calculates the actual aggregates. For each numeric statistic, a mean, stdev and count column get generated.
    
    Parameters:
    
    stats - the statistics to aggregate
    
    Returns:
    
    the aggregated values
  - aggregate
```
public List<EvaluationStatistics> aggregate(List<EvaluationStatistics> stats)
```
    Aggregates the statistics and returns these.
    
    Specified by:
    
    aggregate in interface AggregatedEvaluationStatisticsExporter
    
    Parameters:
    
    stats - the statistics to aggregate
    
    Returns:
    
    the aggregated stats
  - doExport
```
protected String doExport(List<EvaluationStatistics> stats)
```
    Exports the statistics.
    
    Specified by:
    
    doExport in class AbstractEvaluationStatisticsExporter
    
    Parameters:
    
    stats - the statistics to export
    
    Returns:
    
    null if successfully exported, otherwise error message

Class SimpleAggregate

Field Summary

Fields inherited from class meka.experiment.statisticsexporters.AbstractMetaEvaluationStatisticsExporter

Fields inherited from class meka.events.LogObject

Constructor Summary

Method Summary

Methods inherited from class meka.experiment.statisticsexporters.AbstractMetaEvaluationStatisticsExporter

Methods inherited from class meka.experiment.statisticsexporters.AbstractEvaluationStatisticsExporter

Methods inherited from class meka.events.LogObject

Methods inherited from class java.lang.Object

Methods inherited from interface meka.experiment.statisticsexporters.EvaluationStatisticsExporter

Methods inherited from interface meka.events.LogSupporter

Field Detail

SUFFIX_COUNT

SUFFIX_MEAN

SUFFIX_STDEV

m_AggregationKeys

m_SuffixCount

m_SuffixMean

m_SuffixStdDev

m_SkipCount

m_SkipMean

m_SkipStdDev

Constructor Detail

SimpleAggregate

Method Detail

globalInfo

getDefaultExporter

getDefaultAggregationKeys

setAggregationKeys

getAggregationKeys

aggregationKeysTipText

getDefaultSuffixCount

setSuffixCount

getSuffixCount

suffixCountTipText

getDefaultSuffixMean

setSuffixMean

getSuffixMean

suffixMeanTipText

getDefaultSuffixStdDev

setSuffixStdDev

getSuffixStdDev

suffixStdDevTipText

setSkipCount

getSkipCount

skipCountTipText

setSkipMean

getSkipMean

skipMeanTipText

setSkipStdDev

getSkipStdDev

skipStdDevTipText

listOptions

setOptions

getOptions

doAggregate

aggregate

doExport