Package adams.core.option.help

Class SupportedTags

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.option.help.AbstractHelpGenerator

adams.core.option.help.SupportedTags

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class SupportedTags
extends AbstractHelpGenerator

Generates help for classes that implement the adams.data.processing.TagProcessor interface.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-title <java.lang.String> (property: title)
    The title to use in the help output.
    default: Supported tags
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

TagHandler, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Title	the title to use.

Fields inherited from class adams.core.option.help.AbstractHelpGenerator

LOGGER, m_ClassCrossRefLinks

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	generate(Object obj, HelpFormat format)	Generates the help for the object in the requested format.
String	getTitle()	Returns the title to use for the help.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Class cls)	Checks whether the generator handles this class.
void	setTitle(String value)	Sets the title to use for the help.
String	titleTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.option.help.AbstractHelpGenerator

classCrossRefLinksTipText, generateAll, getClassCrossRefLinks, handles, setClassCrossRefLinks, toHTML, toHTML

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_Title

protected String m_Title

the title to use.

Constructor Detail

SupportedTags

public SupportedTags()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractHelpGenerator

setTitle

public void setTitle(String value)

Sets the title to use for the help.

Parameters:

value - the title

getTitle

public String getTitle()

Returns the title to use for the help.

Returns:

the title

titleTipText

public String titleTipText()

Returns the tip text for this property.

Returns:

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

handles

public boolean handles(Class cls)

Checks whether the generator handles this class.

Specified by:

handles in class AbstractHelpGenerator

Parameters:

cls - the class to check

Returns:

true if it can handle the class

generate

public String generate(Object obj,
                       HelpFormat format)

Generates the help for the object in the requested format.

Specified by:

generate in class AbstractHelpGenerator

Parameters:

obj - the object to generate the help for

format - the format of the output

Returns:

the generated help