Class PropertiesToVariables

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

    - accepts:
    - generates:

    -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: PropertiesToVariables
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -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
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
        The regular expression to match the property names against.
        default: .*
    -variable-prefix <java.lang.String> (property: variablePrefix)
        The prefix to prepend the property names with to make up the variable name.
    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 properties must match.
      • m_VariablePrefix

        protected String m_VariablePrefix
        the prefix for the variables.
    • Constructor Detail

      • PropertiesToVariables

        public PropertiesToVariables()
    • Method Detail

      • setRegExp

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

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

        public String regExpTipText()
        Returns the tip text for this property.
        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 + property key).
        value - the prefix
      • getVariablePrefix

        public String getVariablePrefix()
        Returns the prefix for the variables (prefix + property key).
        the prefix
      • variablePrefixTipText

        public String variablePrefixTipText()
        Returns the tip text for this property.
        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.
        java.util.Properties.class, adams.core.Properties.class
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        java.util.Properties.class, adams.core.Properties.class
      • doExecute

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