Package adams.flow.processor

Class ListAllVariables

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.ListAllVariables

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, GraphicalOutputProducingProcessor, ListingProcessor, Serializable, Comparable<ActorProcessor>

public class ListAllVariables
extends AbstractActorProcessor
implements GraphicalOutputProducingProcessor, ListingProcessor

Lists all variable occurrences in the flow whether being set or used.

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

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	m_Variables	the variables in use.

Fields inherited from class adams.flow.processor.AbstractActorProcessor

m_Errors

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

Method Summary

Modifier and Type	Method	Description
Component	getGraphicalOutput()	Returns the graphical output that was generated.
List<String>	getList()	Returns the list.
String	getTitle()	Returns the title for the dialog.
List<String>	getVariables()	Returns the variables.
String	globalInfo()	Returns a string describing the object.
boolean	hasGraphicalOutput()	Returns whether graphical output was generated.
protected void	initialize()	Initializes the members.
protected void	processActor(Actor actor)	Performs the actual processing.

Methods inherited from class adams.flow.processor.AbstractActorProcessor

addError, addError, checkData, compareTo, equals, getErrors, hasErrors, process, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.processor.ActorProcessor

compareTo, getErrors, hasErrors, process, shallowCopy, shallowCopy

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Field Detail

m_Variables

protected List<String> m_Variables

the variables in use.

Constructor Detail

ListAllVariables

public ListAllVariables()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActorProcessor

processActor

protected void processActor(Actor actor)

Performs the actual processing.

Specified by:

processActor in class AbstractActorProcessor

Parameters:

actor - the actor to process

See Also:

ModifyingProcessor

hasGraphicalOutput

public boolean hasGraphicalOutput()

Returns whether graphical output was generated.

Specified by:

hasGraphicalOutput in interface GraphicalOutputProducingProcessor

Returns:

true if graphical output was generated

getTitle

public String getTitle()

Returns the title for the dialog.

Specified by:

getTitle in interface GraphicalOutputProducingProcessor

Returns:

the title

getGraphicalOutput

public Component getGraphicalOutput()

Returns the graphical output that was generated.

Specified by:

getGraphicalOutput in interface GraphicalOutputProducingProcessor

Returns:

the graphical output

getVariables

public List<String> getVariables()

Returns the variables.

Returns:

the variables

getList

public List<String> getList()

Returns the list.

Specified by:

getList in interface ListingProcessor

Returns:

the list