Package adams.gui.tools.wekainvestigator.tab.clustertab.output

Class TextStatistics

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.wekainvestigator.output.AbstractOutputGenerator<ResultItem>

adams.gui.tools.wekainvestigator.tab.clustertab.output.AbstractOutputGenerator

adams.gui.tools.wekainvestigator.tab.clustertab.output.TextStatistics

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class TextStatistics
extends AbstractOutputGenerator

Generates basic text statistic.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_RunInformation	whether to print the run information as well.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TextStatistics()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateOutput(ResultItem item)	Checks whether output can be generated from this item.
JComponent	createOutput(ResultItem item, adams.core.MessageCollection errors)	Generates output from the item.
void	defineOptions()	Adds options to the internal list of options.
boolean	getRunInformation()	Returns whether the run information is output as well.
String	getTitle()	The title to use for the tab.
String	globalInfo()	Returns a string describing the object.
String	runInformationTipText()	Returns the tip text for this property.
void	setRunInformation(boolean value)	Sets whether the run information is output as well.

Methods inherited from class adams.gui.tools.wekainvestigator.output.AbstractOutputGenerator

addTab, generateOutput

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_RunInformation

protected boolean m_RunInformation

whether to print the run information as well.

Constructor Detail

TextStatistics

public TextStatistics()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

getTitle

public String getTitle()

The title to use for the tab.

Specified by:

getTitle in class AbstractOutputGenerator<ResultItem>

Returns:

the title

setRunInformation

public void setRunInformation(boolean value)

Sets whether the run information is output as well.

Parameters:

value - if true then the run information is output as well

getRunInformation

public boolean getRunInformation()

Returns whether the run information is output as well.

Returns:

true if the run information is output as well

runInformationTipText

public String runInformationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

canGenerateOutput

public boolean canGenerateOutput(ResultItem item)

Checks whether output can be generated from this item.

Specified by:

canGenerateOutput in class AbstractOutputGenerator<ResultItem>

Parameters:

item - the item to check

Returns:

true if output can be generated

createOutput

public JComponent createOutput(ResultItem item,
                               adams.core.MessageCollection errors)

Generates output from the item.

Specified by:

createOutput in class AbstractOutputGenerator<ResultItem>

Parameters:

item - the item to generate output for

errors - for collecting error messages

Returns:

the output component, null if failed to generate