Package adams.flow.transformer

Class SetMapValue

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SetMapValue
extends AbstractTransformer
implements StorageUser
    Sets a value in a java.util.Map object.
    The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').

    Input/output:
    - accepts:
       java.util.Map
    - generates:
       java.util.Map


    -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: SetMapValue
 
    -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
 
    -key <java.lang.String> (property: key)
    The key of the value to set.
    default:
 
    -type <VALUE|SOURCE|STORAGE> (property: type)
    Determines how to obtain the value to store in the map.
    default: VALUE
 
    -value <java.lang.String> (property: value)
    The value to set.
    default:
 
    -source <adams.flow.core.CallableActorReference> (property: source)
    The callable source to obtain the value from.
    default: unknown
 
    -storage <adams.flow.control.StorageName> (property: storage)
    The storage item to obtain the value from.
    default: storage
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.ObjectToObject
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Key

        protected String m_Key
        the key to set.

      • m_Value

        protected String m_Value
        the value to set.

      • m_Storage

        protected StorageName m_Storage
        the storage item.

      • m_SourceActor

        protected Actor m_SourceActor
        the callable source actor.

      • m_Conversion

        protected Conversion m_Conversion
        for processing the value.

    • Constructor Detail

      • SetMapValue

        public SetMapValue()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setKey

        public void setKey​(String value)
        Sets the key of the value to set.
        Parameters:
        value - the key

      • getKey

        public String getKey()
        Returns the key of the value to set.
        Returns:
        the key

      • keyTipText

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

      • setType

        public void setType​(SetMapValue.SourceType value)
        Sets the type of source.
        Parameters:
        value - the type

      • typeTipText

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

      • setValue

        public void setValue​(String value)
        Sets the value to set.
        Parameters:
        value - the value

      • getValue

        public String getValue()
        Returns the value to set.
        Returns:
        the value

      • valueTipText

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

      • setSource

        public void setSource​(CallableActorReference value)
        Sets the callable source to obtain the value from.
        Parameters:
        value - the reference

      • getSource

        public CallableActorReference getSource()
        Returns the callable source to obtain the value from.
        Returns:
        the reference

      • sourceTipText

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

      • setStorage

        public void setStorage​(StorageName value)
        Sets the value storage item.
        Parameters:
        value - the storage item

      • getStorage

        public StorageName getStorage()
        Returns the value storage item.
        Returns:
        the storage item

      • storageTipText

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

      • setConversion

        public void setConversion​(Conversion value)
        Sets the type of conversion to perform.
        Parameters:
        value - the type of conversion

      • getConversion

        public Conversion getConversion()
        Returns the type of conversion to perform.
        Returns:
        the type of conversion

      • conversionTipText

        public String conversionTipText()
        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
        Returns:
        java.util.Map.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        java.util.Map.class

      • isUsingStorage

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

      • findCallableActor

        protected Actor findCallableActor()
        Tries to find the callable actor referenced by its callable name.
        Returns:
        the callable actor or null if not found

      • setUp

        public String setUp()
        Description copied from class: AbstractActor
        Initializes the item for flow execution. Also calls the reset() method first before anything else.
        Specified by:
        setUp in interface Actor
        Overrides:
        setUp in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message
        See Also:
        AbstractActor.reset()

      • doExecute

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