Package adams.gui.help

Class WekaOptionHandlerHelpGenerator

java.lang.Object

adams.gui.help.AbstractHelpGenerator

adams.gui.help.WekaOptionHandlerHelpGenerator

public class WekaOptionHandlerHelpGenerator
extends AbstractHelpGenerator

Help generator for OptionHandler.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from class adams.gui.help.AbstractHelpGenerator

m_Generators

Constructor Summary

Constructors

Constructor	Description
WekaOptionHandlerHelpGenerator()

Method Summary

Modifier and Type	Method	Description
protected String	addCapabilities(String title, weka.core.Capabilities c)	generates a string from the capapbilities, suitable to add to the help text.
String	generate(Class cls)	Generates and returns the help for the specified class.
String	generate(Object obj)	Generates and returns the help for the specified object.
boolean	handles(Class cls)	Returns whether this class is handled by this generator.
boolean	isHtml(Class cls)	Returns whether the generated help is HTML or plain text.
protected String	listCapabilities(weka.core.Capabilities c)	returns a comma-separated list of all the capabilities.

Methods inherited from class adams.gui.help.AbstractHelpGenerator

generateHelp, generateHelp, generateHelp, handles, initialize, initializeGenerator, isHtml

Methods inherited from class java.lang.Object

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

Constructor Detail

WekaOptionHandlerHelpGenerator

public WekaOptionHandlerHelpGenerator()

Method Detail

handles

public boolean handles(Class cls)

Returns whether this class is handled by this generator.

Specified by:

handles in class AbstractHelpGenerator

Parameters:

cls - the class to check

Returns:

true if handled

isHtml

public boolean isHtml(Class cls)

Returns whether the generated help is HTML or plain text.

Specified by:

isHtml in class AbstractHelpGenerator

Parameters:

cls - the class to generate the help for

Returns:

true if HTML

listCapabilities

protected String listCapabilities(weka.core.Capabilities c)

returns a comma-separated list of all the capabilities.

Parameters:

c - the capabilities to get a string representation from

Returns:

the string describing the capabilities

addCapabilities

protected String addCapabilities(String title,
                                 weka.core.Capabilities c)

generates a string from the capapbilities, suitable to add to the help text.

Parameters:

title - the title for the capabilities

c - the capabilities

Returns:

a string describing the capabilities

generate

public String generate(Class cls)

Generates and returns the help for the specified class.

Specified by:

generate in class AbstractHelpGenerator

Parameters:

cls - the class to generate the help for

Returns:

the help, null if failed to produce

generate

public String generate(Object obj)

Generates and returns the help for the specified object.

Specified by:

generate in class AbstractHelpGenerator

Parameters:

obj - the object to generate the help for

Returns:

the help, null if failed to produce