Package adams.flow.transformer

Class MapToVariables

  • 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 MapToVariables
extends AbstractTransformer
    Turns the map content into variables.
    Only the map keys that match the regular expression are turned into variables.

    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: MapToVariables
 
    -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
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression to match the map keys against.
    default: .*
    more: https://docs.oracle.com/javase/tutorial/essential/regex/
    https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html
 
    -variable-prefix <java.lang.String> (property: variablePrefix)
    The prefix to prepend the map keys with to make up the variable name.
    default:
 
    -skip-non-primitive <boolean> (property: skipNonPrimitive)
    If enabled, all values get skipped that are not primitive objects.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regular expression that the map keys must match.

      • m_VariablePrefix

        protected String m_VariablePrefix
        the prefix for the variables.

      • m_SkipNonPrimitive

        protected boolean m_SkipNonPrimitive
        whether to skip non-primitive values.

    • Constructor Detail

      • MapToVariables

        public MapToVariables()

    • Method Detail

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expressions to use.
        Parameters:
        value - the regular expressions

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expressions in use.
        Returns:
        the regular expressions

      • regExpTipText

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

      • setVariablePrefix

        public void setVariablePrefix​(String value)
        Sets the prefix for the variables (prefix + map key).
        Parameters:
        value - the prefix

      • getVariablePrefix

        public String getVariablePrefix()
        Returns the prefix for the variables (prefix + map key).
        Returns:
        the prefix

      • variablePrefixTipText

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

      • setSkipNonPrimitive

        public void setSkipNonPrimitive​(boolean value)
        Sets whether to skip non-primitive values.
        Parameters:
        value - true if to skip

      • getSkipNonPrimitive

        public boolean getSkipNonPrimitive()
        Returns whether to skip non-primitive values.
        Returns:
        true if to skip

      • skipNonPrimitiveTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.util.Map.class

      • doExecute

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