Package adams.flow.standalone

Class DeleteVariable

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableUpdater, VariableChangeListener, Actor, ErrorHandler, Serializable, Comparable
    public class DeleteVariable
extends AbstractStandalone
implements VariableUpdater
    Removes a variable by name or the variables that match the regular expression. 

    -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: DeleteVariable
 
    -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
 
    -type <NAME|REGEXP> (property: type)
    How to determine the variable(s) to delete.
    default: NAME
 
    -var-name <adams.core.VariableName> (property: variableName)
    The name of the variable to update.
    default: variable
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression used for matching the variable names to delete.
    default: variable
    more: https://docs.oracle.com/javase/tutorial/essential/regex/
    https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_VariableName

        protected VariableName m_VariableName
        the name of the variable.

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regexp to match against variable names.

    • Constructor Detail

      • DeleteVariable

        public DeleteVariable()

    • Method Detail

      • setType

        public void setType​(DeleteVariable.MatchingType value)
        Sets how to determine variables to delete.
        Parameters:
        value - the matching 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.

      • setVariableName

        public void setVariableName​(VariableName value)
        Sets the name of the variable to update.
        Parameters:
        value - the name

      • getVariableName

        public VariableName getVariableName()
        Returns the name of the variable to update.
        Returns:
        the name

      • variableNameTipText

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

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression to match the variable names against.
        Parameters:
        value - the regular expression

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression to match the variable names against.
        Returns:
        the regular expression

      • 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.

      • isUpdatingVariables

        public boolean isUpdatingVariables()
        Returns whether variables are being updated.
        Specified by:
        isUpdatingVariables in interface VariableUpdater
        Returns:
        true if variables are updated

      • doExecute

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