Package adams.core.option

Class VariableLister

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.option.AbstractOptionTraverser

adams.core.option.AbstractOptionTraverserWithResult<String>

adams.core.option.VariableLister

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, OptionTraverser, OptionTraverserWithResult<String>, SizeOfHandler, Serializable

public class VariableLister
extends AbstractOptionTraverserWithResult<String>

Lists all variables in the flow.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	m_Result	for storing the result.

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

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(AbstractOption option)	Returns whether the traverser is allowed to "handle" this option.
boolean	canRecurse(Class cls)	Returns whether the traverser can recurse the specified class (base class from a ClassOption).
boolean	canRecurse(Object obj)	Returns whether the traverser can recurse the specified object.
String	getResult()	Returns the result of the traversal.
String	globalInfo()	Returns a string describing the object.
void	handleArgumentOption(AbstractArgumentOption option, OptionTraversalPath path)	Handles the encountered argument option.
void	handleBooleanOption(BooleanOption option, OptionTraversalPath path)	Handles the encountered boolean option.
void	handleClassOption(ClassOption option, OptionTraversalPath path)	Handles the encountered class option.
void	resetResult()	Resets the result before traversing.

Methods inherited from class adams.core.option.AbstractOptionTraverserWithResult

reset

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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_Result

protected StringBuilder m_Result

for storing the result.

Constructor Detail

VariableLister

public VariableLister()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class AbstractOptionTraverser

Returns:

a description suitable for displaying in the gui

resetResult

public void resetResult()

Resets the result before traversing.

Specified by:

resetResult in interface OptionTraverserWithResult<String>

Specified by:

resetResult in class AbstractOptionTraverserWithResult<String>

handleBooleanOption

public void handleBooleanOption(BooleanOption option,
                                OptionTraversalPath path)

Handles the encountered boolean option.

Specified by:

handleBooleanOption in interface OptionTraverser

Specified by:

handleBooleanOption in class AbstractOptionTraverser

Parameters:

option - the option to handle

path - the property path so far

handleClassOption

public void handleClassOption(ClassOption option,
                              OptionTraversalPath path)

Handles the encountered class option. Precedence over argument option.

Specified by:

handleClassOption in interface OptionTraverser

Specified by:

handleClassOption in class AbstractOptionTraverser

Parameters:

option - the option to handle

path - the property path so far

handleArgumentOption

public void handleArgumentOption(AbstractArgumentOption option,
                                 OptionTraversalPath path)

Handles the encountered argument option.

Specified by:

handleArgumentOption in interface OptionTraverser

Specified by:

handleArgumentOption in class AbstractOptionTraverser

Parameters:

option - the option to handle

path - the property path so far

canHandle

public boolean canHandle(AbstractOption option)

Returns whether the traverser is allowed to "handle" this option.

Specified by:

canHandle in interface OptionTraverser

Specified by:

canHandle in class AbstractOptionTraverser

Parameters:

option - the option to check whether it can be handled

Returns:

true if handling via handleArgumentOption(AbstractArgumentOption, OptionTraversalPath), handleClassOption(ClassOption, OptionTraversalPath) or handleBooleanOption(BooleanOption, OptionTraversalPath) is allowed

canRecurse

public boolean canRecurse(Class cls)

Returns whether the traverser can recurse the specified class (base class from a ClassOption).

Specified by:

canRecurse in interface OptionTraverser

Specified by:

canRecurse in class AbstractOptionTraverser

Parameters:

cls - the class to determine for whether recursing is possible or not

Returns:

true if to traverse the options recursively

canRecurse

public boolean canRecurse(Object obj)

Returns whether the traverser can recurse the specified object.

Specified by:

canRecurse in interface OptionTraverser

Specified by:

canRecurse in class AbstractOptionTraverser

Parameters:

obj - the Object to determine for whether recursing is possible or not

Returns:

true if to traverse the options recursively

getResult

public String getResult()

Returns the result of the traversal.

Specified by:

getResult in interface OptionTraverserWithResult<String>

Specified by:

getResult in class AbstractOptionTraverserWithResult<String>

Returns:

the result