Package adams.flow.processor

Class ListActorUsage

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.ListActorUsage

All Implemented Interfaces:

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

public class ListActorUsage
extends AbstractActorListingProcessor

Looks for all the occurrences of the specified actor class.

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

-actor-class <adams.core.base.BaseClassname> (property: actorClass)
    The actor class to look for.
    default: adams.flow.standalone.SetVariable
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseClassname	m_ActorClass	the actor class to look for.
protected Class	m_ActualClass	the actual class to look for.

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

Method Summary

Modifier and Type	Method	Description
String	actorClassTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
BaseClassname	getActorClass()	Returns the actor class to look for.
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	isValid(AbstractOption option, Object obj, OptionTraversalPath path)	Checks whether the object is valid and should be added to the list.
void	setActorClass(BaseClassname value)	Sets the actor class to look for.

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

Field Detail

m_ActorClass

protected BaseClassname m_ActorClass

the actor class to look for.

m_ActualClass

protected transient Class m_ActualClass

the actual class to look for.

Constructor Detail

ListActorUsage

public ListActorUsage()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setActorClass

public void setActorClass(BaseClassname value)

Sets the actor class to look for.

Parameters:

value - the class

getActorClass

public BaseClassname getActorClass()

Returns the actor class to look for.

Returns:

the class

actorClassTipText

public String actorClassTipText()

Returns the tip text for this property.

Returns:

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

isValid

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

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

Specified by:

isValid in class AbstractListingProcessor

Parameters:

option - the current option

obj - the object to check

path - the traversal path of properties

Returns:

true if valid

getHeader

protected String getHeader()

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

getTitle

public String getTitle()

Returns the title for the dialog.

Returns:

the title