Package adams.flow.processor

Class AbstractModifyingInteractiveProcessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.AbstractModifyingProcessor

adams.flow.processor.AbstractModifyingInteractiveProcessor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, InteractiveProcessor, ModifyingProcessor, Serializable, Comparable<ActorProcessor>

public abstract class AbstractModifyingInteractiveProcessor
extends AbstractModifyingProcessor
implements InteractiveProcessor

Ancestor for processors that interact with the user and potentially modify the flow.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_ContinueInteraction	whether to continue with the processing.

Fields inherited from class adams.flow.processor.AbstractModifyingProcessor

m_Modified, m_ModifiedActor, m_NoCopy

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

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	canRecurse(Class cls)	Returns whether we can recurse into this class.
protected abstract boolean	canRecurse(Object obj)	Returns whether we can recurse into this object.
protected void	handleArgumentOption(AbstractArgumentOption option, OptionTraversalPath path)	Interacts with the user on this argument option if necessary.
protected void	handleBooleanOption(BooleanOption option, OptionTraversalPath path)	Interacts with the user on this boolean option if necessary.
protected void	handleClassOption(ClassOption option, OptionTraversalPath path)	Interacts with the user on this class option if necessary.
protected void	processActor(Actor actor)	Performs the actual processing.

Methods inherited from class adams.flow.processor.AbstractModifyingProcessor

getModifiedActor, getNoCopy, initialize, isModified, process, setNoCopy

Methods inherited from class adams.flow.processor.AbstractActorProcessor

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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.InteractiveProcessor

canInteract, doInteract

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Field Detail

m_ContinueInteraction

protected boolean m_ContinueInteraction

whether to continue with the processing.

Constructor Detail

AbstractModifyingInteractiveProcessor

public AbstractModifyingInteractiveProcessor()

Method Detail

handleBooleanOption

protected void handleBooleanOption(BooleanOption option,
                                   OptionTraversalPath path)

Interacts with the user on this boolean option if necessary.

Parameters:

option - the current option

path - the current traversal path

handleArgumentOption

protected void handleArgumentOption(AbstractArgumentOption option,
                                    OptionTraversalPath path)

Interacts with the user on this argument option if necessary.

Parameters:

option - the current option

path - the current traversal path

handleClassOption

protected void handleClassOption(ClassOption option,
                                 OptionTraversalPath path)

Interacts with the user on this class option if necessary.

Parameters:

option - the current option

path - the current traversal path

canRecurse

protected abstract boolean canRecurse(Class cls)

Returns whether we can recurse into this class.

Parameters:

cls - the class to check

Returns:

true if recursion is allowed

canRecurse

protected abstract boolean canRecurse(Object obj)

Returns whether we can recurse into this object.

Parameters:

obj - the object to check

Returns:

true if recursion is allowed

processActor

protected void processActor(Actor actor)

Performs the actual processing.

Specified by:

processActor in class AbstractActorProcessor

Parameters:

actor - the actor to process (is a copy of original for processors implementing ModifyingProcessor)

See Also:

ModifyingProcessor