Package adams.flow.processor

Class MultiProcessor

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

All Implemented Interfaces:

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

public class MultiProcessor
extends AbstractModifyingProcessor
implements CheckProcessor

A meta-processor that processes the actor sequentially with all sub-processors.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-processor <adams.flow.processor.AbstractActorProcessor> [-processor ...] (property: subProcessors)
    The array of processors to use.
    default:
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ActorProcessor[]	m_Processors	the processors.
protected StringBuilder	m_Warnings	the warnings.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
ActorProcessor[]	getSubProcessors()	Returns the processors in use.
String	getWarningHeader()	Returns the string that explains the warnings.
String	getWarnings()	Returns the warnings, if any, resulting from the check.
String	globalInfo()	Returns a string describing the object.
protected void	processActor(Actor actor)	Performs the actual processing.
void	setSubProcessors(ActorProcessor[] value)	Sets the processors to use.
String	subProcessorsTipText()	Returns the tip text for this property.

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, 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, 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_Processors

protected ActorProcessor[] m_Processors

the processors.

m_Warnings

protected StringBuilder m_Warnings

the warnings.

Constructor Detail

MultiProcessor

public MultiProcessor()

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

setSubProcessors

public void setSubProcessors(ActorProcessor[] value)

Sets the processors to use.

Parameters:

value - the processors to use

getSubProcessors

public ActorProcessor[] getSubProcessors()

Returns the processors in use.

Returns:

the processors

subProcessorsTipText

public String subProcessorsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

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)

See Also:

ModifyingProcessor

getWarningHeader

public String getWarningHeader()

Returns the string that explains the warnings.

Specified by:

getWarningHeader in interface CheckProcessor

Returns:

the heading for the warnings, null if not available

getWarnings

public String getWarnings()

Returns the warnings, if any, resulting from the check.

Specified by:

getWarnings in interface CheckProcessor

Returns:

the warnings, null if no warnings.