adams.flow.template
Class OptionTraverserWithSpreadSheetDisplay

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.template.AbstractActorTemplate
              adams.flow.template.OptionTraverser
                  adams.flow.template.OptionTraverserWithSpreadSheetDisplay

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable

public class OptionTraverserWithSpreadSheetDisplay
extends OptionTraverser

Generates a sub-flow that displays the result of the specified option traversal algorithm, e.g., for displaying currently attached variables.
Displays the results in a table.

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
 

-name <java.lang.String> (property: name)
    The new name for the actor; leave empty to use current.
    default: 
 

-traverser <adams.core.option.OptionTraverser> (property: traverser)
    The traverser to use.
    default: adams.core.option.VariableLister
 

-start <ROOT|PARENT> (property: start)
    Defines where to start the traversal from.
    default: ROOT
 

-once (property: once)
    If enabled, the option traversal gets executed only once.
 

Version:

$Revision: 5700 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.template.OptionTraverser

m_Once, m_Start, m_Traverser

Fields inherited from class adams.flow.template.AbstractActorTemplate

m_Name

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

OptionTraverserWithSpreadSheetDisplay()

Method Summary

protected void	addDisplay(MutableActorHandler handler) Adds the display actors.
String	globalInfo() Returns a string describing the object.

Methods inherited from class adams.flow.template.OptionTraverser

defineOptions, doGenerate, getOnce, getStart, getTraverser, onceTipText, setOnce, setStart, setTraverser, startTipText, traverserTipText

Methods inherited from class adams.flow.template.AbstractActorTemplate

compareTo, equals, forCommandLine, forName, generate, getBaselineCorrections, getName, nameTipText, postGenerate, preGenerate, setName, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionTraverserWithSpreadSheetDisplay

public OptionTraverserWithSpreadSheetDisplay()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Overrides:

globalInfo in class OptionTraverser

Returns:

a description suitable for displaying in the gui

addDisplay

protected void addDisplay(MutableActorHandler handler)

Adds the display actors.

Overrides:

addDisplay in class OptionTraverser

Parameters:

handler - the handler to add the display actors to