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

Class Supplementary

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.Supplementary

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 Supplementary
extends AbstractOutputGenerator

Outputs the supplementary data if available.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Title	the title.

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
Supplementary()

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.
String	getTitle()	The title to use for the tab.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.

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

addTab, generateOutput

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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_Title

protected String m_Title

the title.

Constructor Detail

Supplementary

public Supplementary()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize 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

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