Package adams.flow.control

Class PlotContainerUpdater

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.control.AbstractControlActor

adams.flow.control.AbstractDirectedControlActor

adams.flow.control.AbstractConnectedControlActor

adams.flow.control.MutableConnectedControlActor

adams.flow.control.Sequence

adams.flow.control.SubProcess

adams.flow.control.AbstractContainerUpdater

adams.flow.control.PlotContainerUpdater

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ActorWithConditionalEquivalent, ActorWithTimedEquivalent, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OptionalStopRestrictor, OutputProducer, PauseStateHandler, StopRestrictor, SubFlowWrapUp, Serializable, Comparable

public class PlotContainerUpdater
extends AbstractContainerUpdater

Applies all sub-actors to process either the selected value of the plot container.

Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
- generates:
adams.flow.container.SequencePlotterContainer


Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData

Conditional equivalent:
adams.flow.control.ConditionalSubProcess

-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 name of the actor.
    default: PlotContainerUpdater
 

-annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 

-silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 

-finish-before-stopping <boolean> (property: finishBeforeStopping)
    If enabled, actor first finishes processing all data before stopping.
    default: false
 

-actor <adams.flow.core.AbstractActor> [-actor ...] (property: actors)
    All the actors that define this sequence.
    default: 
 

-container-value <PLOT_NAME|X_VALUE|Y_VALUE|X_ERROR_VALUE|Y_ERROR_VALUE|META_DATA> (property: containerValue)
    The type of value to update.
    default: Y_VALUE
 

-meta-data-key <java.lang.String> (property: metaDataKey)
    The key to use when updating meta-data.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlotContainerUpdater.PlotContainerValue	The values of the plot container that can be modified.

Nested classes/interfaces inherited from class adams.flow.control.SubProcess

SubProcess.SubProcessDirector

Field Summary

Fields

Modifier and Type	Field	Description
protected PlotContainerUpdater.PlotContainerValue	m_ContainerValue	the value to modify.
protected String	m_MetaDataKey	the key in case of meta-data.

Fields inherited from class adams.flow.control.AbstractContainerUpdater

BACKUP_OUTPUT, m_ContainerValueName, m_OutputToken

Fields inherited from class adams.flow.control.SubProcess

m_AllowEmpty, m_OutputTokens

Fields inherited from class adams.flow.control.Sequence

BACKUP_CURRENT, m_AllowSource, m_AllowStandalones, m_CurrentToken, m_RestrictedStop, m_RestrictingStops

Fields inherited from class adams.flow.control.MutableConnectedControlActor

m_Actors

Fields inherited from class adams.flow.control.AbstractDirectedControlActor

m_Director, m_FinishBeforeStopping, m_StoppingTimeout, m_StoppingWarningInterval

Fields inherited from class adams.flow.control.AbstractControlActor

m_Compatibility, m_PauseStateManager, m_SetUpSubActors

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
PlotContainerUpdater()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
String	containerValueTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
Class[]	generates()	Returns the class of objects that it generates.
PlotContainerUpdater.PlotContainerValue	getContainerValue()	Returns the type of value to update.
protected Object	getContainerValue(AbstractContainer cont)	Tries to obtain the container value.
String	getMetaDataKey()	Returns the meta-data key to use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	metaDataKeyTipText()	Returns the tip text for this property.
void	setContainerValue(PlotContainerUpdater.PlotContainerValue value)	Sets the type of value to update.
void	setMetaDataKey(String value)	Sets the meta-data key to use.
String	setUp()	Initializes the item for flow execution.

Methods inherited from class adams.flow.control.AbstractContainerUpdater

backupState, doExecute, getContainerValueName, hasPendingOutput, input, output, postExecute, reset, restoreState, setContainerValueName, wrapUp

Methods inherited from class adams.flow.control.SubProcess

addOutputToken, cleanUp, execute, getAllowEmpty, getConditionalEquivalent, getOutputTokens, getPauseStateManager, getTimedEquivalent, initialize, newDirector, setAllowEmpty

Methods inherited from class adams.flow.control.Sequence

actorsTipText, currentInput, getActorHandlerInfo, getAllowSource, getAllowStandalones, getDefaultRestrictingStops, hasInput, isRestrictedStop, isRestrictingStops, preExecute, restrictedStopExecution, restrictedStopExecution, setAllowSource, setAllowStandalones, setRestrictingStops

Methods inherited from class adams.flow.control.MutableConnectedControlActor

add, add, get, getActors, indexOf, remove, removeAll, set, setActors, size

Methods inherited from class adams.flow.control.AbstractConnectedControlActor

check, checkConnections, classesToString

Methods inherited from class adams.flow.control.AbstractDirectedControlActor

finishBeforeStoppingTipText, flushExecution, getDirector, getFinishBeforeStopping, getStoppingTimeout, getStoppingWarningInterval, setFinishBeforeStopping, setStoppingTimeout, setStoppingWarningInterval, stopExecution, stoppingTimeoutTipText, stoppingWarningIntervalTipText, updateVariables

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, forceVariables, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, resumeExecution, setParent, setUpSubActors, updateParent, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canPerformSetUpCheck, compareTo, configureLogger, equals, finalUpdateVariables, findVariables, findVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.flow.core.ActorHandler

check, firstActive, flushExecution, lastActive

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_ContainerValue

protected PlotContainerUpdater.PlotContainerValue m_ContainerValue

the value to modify.

m_MetaDataKey

protected String m_MetaDataKey

the key in case of meta-data.

Constructor Detail

PlotContainerUpdater

public PlotContainerUpdater()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class SubProcess

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 MutableConnectedControlActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractDirectedControlActor

Returns:

null if no info available, otherwise short string

setContainerValue

public void setContainerValue(PlotContainerUpdater.PlotContainerValue value)

Sets the type of value to update.

Parameters:

value - the type of value

getContainerValue

public PlotContainerUpdater.PlotContainerValue getContainerValue()

Returns the type of value to update.

Returns:

the type of value

containerValueTipText

public String containerValueTipText()

Returns the tip text for this property.

Returns:

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

setMetaDataKey

public void setMetaDataKey(String value)

Sets the meta-data key to use.

Parameters:

value - the key

getMetaDataKey

public String getMetaDataKey()

Returns the meta-data key to use.

Returns:

the key

metaDataKeyTipText

public String metaDataKeyTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Overrides:

accepts in class AbstractContainerUpdater

Returns:

the Class of objects that can be processed

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Overrides:

generates in class AbstractContainerUpdater

Returns:

the Class of the generated tokens

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class SubProcess

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()

getContainerValue

protected Object getContainerValue(AbstractContainer cont)

Tries to obtain the container value.

Overrides:

getContainerValue in class AbstractContainerUpdater

Parameters:

cont - the container to obtain the value from

Returns:

the value, if available

Throws:

IllegalStateException - if failed to obtain value