Package adams.flow.transformer

Class GetMapValue

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class GetMapValue
extends AbstractTransformer
    Obtains the value associated with the specified key from Map object received as input and forwards it.

    Input/output:
    - accepts:
       java.util.Map
    - generates:
       adams.flow.core.Unknown


    -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: GetMapValue
 
    -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; 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 retrieve.
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Key

        protected String m_Key
        the key of the value to retrieve.

    • Constructor Detail

      • GetMapValue

        public GetMapValue()

    • Method Detail

      • setKey

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

      • getKey

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

      • keyTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        java.util.Map.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.flow.core.Unknown.class

      • doExecute

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