Package adams.flow.control

Class SetContainerValue

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ControlActor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SetContainerValue
extends AbstractTransformer
implements ControlActor, StorageUser
    Updates a single item in the container passing through, using either the data obtained from a callable actor or a storage item.
    Using the 'force' option, additional meta-data can be stored in the container as well.

    Input/output:
    - accepts:
       adams.flow.container.AbstractContainer
    - generates:
       java.lang.Object


    Container information:
    - adams.flow.container.AbstractContainer: 

    -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: SetContainerValue
 
    -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 execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -callable-actor <adams.flow.core.CallableActorReference> (property: callableActor)
    The callable actor to obtain the data from.
    default:
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The storage item to use.
    default: storage
 
    -use-storage <boolean> (property: useStorage)
    Whether to use storage items or data from callable actors.
    default: false
 
    -value-name <adams.core.base.BaseString> (property: valueName)
    The name to use for storing the value in the container.
    default:
 
    -force <boolean> (property: force)
    If enabled, the value is stored regardless whether a valid name or not (
    eg additional meta-data).
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CallableActor

        protected CallableActorReference m_CallableActor
        the callable actor to retrieve the data from.

      • m_StorageName

        protected StorageName m_StorageName
        the storage name to retrieve the data from.

      • m_ValueName

        protected BaseString m_ValueName
        the name under which to store the data.

      • m_UseStorage

        protected boolean m_UseStorage
        whether to use callable actors or storage.

      • m_Force

        protected boolean m_Force
        whether to force the setting.

    • Constructor Detail

      • SetContainerValue

        public SetContainerValue()

    • Method Detail

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface StorageUser
        Returns:
        true if storage items are used

      • setCallableActor

        public void setCallableActor​(CallableActorReference value)
        Sets the name of the callable actors to obtain the data from.
        Parameters:
        value - the name

      • getCallableActor

        public CallableActorReference getCallableActor()
        Returns the name of the callable actors to get the data form.
        Returns:
        the name

      • callableActorTipText

        public String callableActorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name of the storage item to use.
        Parameters:
        value - the name

      • getStorageName

        public StorageName getStorageName()
        Returns the name of the storage item to use.
        Returns:
        the name

      • storageNameTipText

        public String storageNameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setUseStorage

        public void setUseStorage​(boolean value)
        Sets whether to use storage items or data from callable actors.
        Parameters:
        value - true if to use storage

      • getUseStorage

        public boolean getUseStorage()
        Returns whether to use storage items or data from callable actors.
        Returns:
        true if to use storage

      • useStorageTipText

        public String useStorageTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setValueName

        public void setValueName​(BaseString value)
        Sets the name of the value in the container.
        Parameters:
        value - the name

      • getValueName

        public BaseString getValueName()
        Returns the name to store the value under in the container.
        Returns:
        the name

      • valueNameTipText

        public String valueNameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setForce

        public void setForce​(boolean value)
        Sets whether to force the setting, ie the value is stored regardless whether a valid name or not (eg additional meta-data)
        Parameters:
        value - true if to force

      • getForce

        public boolean getForce()
        Returns whether to force the setting, ie the value is stored regardless whether a valid name or not (eg additional meta-data)
        Returns:
        true if to force setting

      • forceTipText

        public String forceTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getValue

        protected Object getValue​(CallableActorReference name)
        Returns the value obtained from the callable actor.
        Parameters:
        name - the name of the callable actor to get the value from
        Returns:
        the obtained value

      • getValue

        protected Object getValue​(StorageName name)
        Returns the value obtained from the callable actor.
        Parameters:
        name - the name of the callable actor to get the value from
        Returns:
        the obtained value

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        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
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message