Package adams.flow.processor

Class ListVariableUsage

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.AbstractListingProcessor

adams.flow.processor.AbstractActorListingProcessor

adams.flow.processor.AbstractListNameUsage<VariableName>

adams.flow.processor.ListVariableUsage

All Implemented Interfaces:

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

public class ListVariableUsage
extends AbstractListNameUsage<VariableName>

Lists all the actors where the specified variable is used.

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

-name <java.lang.String> (property: name)
    The variable name to look for.
    default: 
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.processor.AbstractListNameUsage

m_Name

Fields inherited from class adams.flow.processor.AbstractActorListingProcessor

m_Context, m_Current

Fields inherited from class adams.flow.processor.AbstractListingProcessor

m_List

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

Method Summary

Modifier and Type	Method	Description
protected String	getHeader()	Returns the header to use in the dialog, i.e., the one-liner that explains the output.
String	getTitle()	Returns the title for the dialog.
String	globalInfo()	Returns a string describing the object.
protected boolean	isNameMatch(Object obj)	Checks whether the located object matches the name that we are looking for.
protected boolean	isValid(AbstractOption option, Object obj, OptionTraversalPath path)	Checks whether the object is valid and should be added to the list.
String	nameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.processor.AbstractListNameUsage

defineOptions, getName, setName

Methods inherited from class adams.flow.processor.AbstractActorListingProcessor

createLocation, findEnclosingActor, findEnclosingActor, getContext, getGraphicalOutput, isSortedList, isUniqueList, objectToString, processActor, setContext

Methods inherited from class adams.flow.processor.AbstractListingProcessor

finalizeList, generatesMultipleItems, getDefaultSize, getList, hasGraphicalOutput, initializeList, objectToStrings, process

Methods inherited from class adams.flow.processor.AbstractActorProcessor

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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, getOptionManager, toCommandLine

Constructor Detail

ListVariableUsage

public ListVariableUsage()

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

nameTipText

public String nameTipText()

Returns the tip text for this property.

Specified by:

nameTipText in class AbstractListNameUsage<VariableName>

Returns:

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

getTitle

public String getTitle()

Returns the title for the dialog.

Returns:

the title

isNameMatch

protected boolean isNameMatch(Object obj)

Checks whether the located object matches the name that we are looking for.

Specified by:

isNameMatch in class AbstractListNameUsage<VariableName>

Parameters:

obj - the object to check

Returns:

true if a match

isValid

protected boolean isValid(AbstractOption option,
                          Object obj,
                          OptionTraversalPath path)

Checks whether the object is valid and should be added to the list.

Overrides:

isValid in class AbstractListNameUsage<VariableName>

Parameters:

option - the current option

obj - the object to check

path - the traversal path of properties

Returns:

true if valid

getHeader

protected String getHeader()

Description copied from class: AbstractListingProcessor

Returns the header to use in the dialog, i.e., the one-liner that explains the output.

Specified by:

getHeader in class AbstractListingProcessor

Returns:

the header, null if no header available