Package adams.flow.source

Class Variable

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableUser, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class Variable
extends AbstractSimpleSource
implements VariableUser
    Outputs the string value of the specified variable.
    Does nothing if the variable hasn't been set.

    Input/output:
    - generates:
       java.lang.String


    -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: Variable
 
    -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
 
    -var-name <adams.core.VariableName> (property: variableName)
    The name of the variable to update.
    default: variable
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.StringToString
    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_VariableValue

        protected String m_VariableValue
        the value of the variable.

      • m_Conversion

        protected Conversion m_Conversion
        the type of conversion.

    • Constructor Detail

      • Variable

        public Variable()
        Default constructor.

      • Variable

        public Variable​(VariableName variableName)
        Initializes with the specified name.
        Parameters:
        variableName - the name to use

      • Variable

        public Variable​(String variableName)
        Initializes with the specified name.
        Parameters:
        variableName - the name to use

    • Method Detail

      • setVariableName

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

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

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

      • isUsingVariables

        public boolean isUsingVariables()
        Returns whether variables are being used.
        Specified by:
        isUsingVariables in interface VariableUser
        Returns:
        true if variables are used

      • generates

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

      • doExecute

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