Package adams.flow.processor

Class AbstractListNameUsage<T>

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<T>

Type Parameters:

T - the type of

All Implemented Interfaces:

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

Direct Known Subclasses:

ListActorReferenceUsage, ListCallableActorUsage, ListStorageUsage, ListVariableUsage

public abstract class AbstractListNameUsage<T>
extends AbstractActorListingProcessor

Ancestor for processors that locate usages of a certain name.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Name	the name 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
AbstractListNameUsage()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	getName()	Returns the name to look for.
protected abstract 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.
abstract String	nameTipText()	Returns the tip text for this property.
void	setName(String value)	Sets the name 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, getHeader, 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, globalInfo, 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.flow.processor.GraphicalOutputProducingProcessor

getTitle

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Name

protected String m_Name

the name to look for.

Constructor Detail

AbstractListNameUsage

public AbstractListNameUsage()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setName

public void setName(String value)

Sets the name to look for.

Parameters:

value - the name

getName

public String getName()

Returns the name to look for.

Returns:

the name

nameTipText

public abstract String nameTipText()

Returns the tip text for this property.

Returns:

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

isNameMatch

protected abstract boolean isNameMatch(Object obj)

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

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.

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