java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractActor
      - adams.flow.standalone.AbstractStandalone
        
        adams.flow.standalone.SetVariable

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 SetVariable
extends AbstractStandalone
implements VariableUpdater
```
Sets the value of a variable.
Optionally, the specified value can be expanded, in case it is made up of variables itself.
It is also possible to override the variable value with the value obtained from an environment variable.

Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):

expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;

expr ::= ( expr )

# data types
| number
| string
| boolean
| date

# constants
| true
| false
| pi
| e
| now()
| today()

# negating numeric value
| -expr

# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)

# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )

# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;

# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )

# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;

Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g. 'len("abc")' is the same as 'length("abc")'
- 'str' uses java.text.DecimalFormat when supplying a format string

A lot of the functions have been modeled after LibreOffice:
https://help.libreoffice.org/Calc/Functions_by_Category

Additional functions:
- env(String): String
   First argument is the name of the environment variable to retrieve.
   The result is the value of the environment variable.

Additional procedures:
- println(...)
   One or more arguments are printed as comma-separated list to stdout.
   If no argument is provided, a simple line feed is output.

Grammar for boolean expressions (value type 'BOOL_EXPRESSION'):

expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;

expr ::= ( expr )

# data types
| number
| string
| boolean
| date

# constants
| true
| false
| pi
| e
| now()
| today()

# negating numeric value
| -expr

# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)

# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )

# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;

# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )

# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)

# array functions
| len[gth] ( array )
| get ( array , index )
;

Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g. 'len("abc")' is the same as 'length("abc")'
- 'str' uses java.text.DecimalFormat when supplying a format string

A lot of the functions have been modeled after LibreOffice:
https://help.libreoffice.org/Calc/Functions_by_Category

Additional functions:
- env(String): String
   First argument is the name of the environment variable to retrieve.
   The result is the value of the environment variable.

Additional procedures:
- println(...)
   One or more arguments are printed as comma-separated list to stdout.
   If no argument is provided, a simple line feed is output.

Grammar for string expressions (value type 'STRING_EXPRESSION'):

expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;

expr ::= ( expr )

# data types
| number
| string
| boolean
| date

# constants
| true
| false
| pi
| e
| now()
| today()

# negating numeric value
| -expr

# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)

# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )

# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;

# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )

# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)

# array functions
| len[gth] ( array )
| get ( array , index )
;

Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g. 'len("abc")' is the same as 'length("abc")'
- 'str' uses java.text.DecimalFormat when supplying a format string

A lot of the functions have been modeled after LibreOffice:
https://help.libreoffice.org/Calc/Functions_by_Category

Additional functions:
- env(String): String
   First argument is the name of the environment variable to retrieve.
   The result is the value of the environment variable.

Additional procedures:
- println(...)
   One or more arguments are printed as comma-separated list to stdout.
   If no argument is provided, a simple line feed is output.
```
-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: SetVariable
 
```
```
-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
 
```
```
-var-value <adams.core.base.BaseText> (property: variableValue)
    The value for the variable to use.
    default: value
 
```
```
-value-type <STRING|MATH_EXPRESSION|MATH_EXPRESSION_ROUND|BOOL_EXPRESSION|STRING_EXPRESSION|FILE_FORWARD_SLASHES> (property: valueType)
    How to interpret the 'value' string.
    default: STRING
 
```
```
-expand-value <boolean> (property: expandValue)
    If enabled, the value gets expanded first in case it is made up of variables
    itself.
    default: false
 
```
```
-override-with-env-var <boolean> (property: overrideWithEnvVar)
    If enabled, the value gets overridden by the value obtained from the specified
    environment variable.
    default: false
 
```
```
-env-variable <java.lang.String> (property: envVariable)
    The name of the environment variable to use for overriding the variable
    value.
    default:
 
```
```
-env-var-optional <boolean> (property: envVarOptional)
    If enabled, the environment does not have to exist and the currently set
    value is used instead; if not optional, a missing environment variable will
    generate an error.
    default: true
 
```
Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`m_EnvVariable`	the environment variable to use.
`protected boolean`	`m_EnvVarOptional`	whether to override using an environment variable.
`protected boolean`	`m_ExpandValue`	whether to expand the value.
`protected boolean`	`m_OverrideWithEnvVar`	whether to override using an environment variable.
`protected VariableValueType`	`m_ValueType`	how to interpret the value.
`protected VariableName`	`m_VariableName`	the name of the variable.
`protected BaseText`	`m_VariableValue`	the value of the variable.

Fields inherited from class adams.flow.core.AbstractActor
m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors
Constructor	Description
`SetVariable()`	Default constructor.
`SetVariable(VariableName name, BaseText value)`	Constructor for setting variable name and value.
`SetVariable(String name, String value)`	Constructor for setting variable name and value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected String`	`doExecute()`	Executes the flow item.
`String`	`envVariableTipText()`	Returns the tip text for this property.
`String`	`envVarOptionalTipText()`	Returns the tip text for this property.
`String`	`expandValueTipText()`	Returns the tip text for this property.
`String`	`getEnvVariable()`	Returns the name of the environment variable to use.
`boolean`	`getEnvVarOptional()`	Returns whether to the environment variable is optional.
`boolean`	`getExpandValue()`	Returns whether the value gets expanded before setting it (eg if it is made up of variables itself).
`boolean`	`getOverrideWithEnvVar()`	Returns whether to override the value with the one obtained from the specified environment variable.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`VariableValueType`	`getValueType()`	Returns how to interpret the value string.
`VariableName`	`getVariableName()`	Returns the name of the variable to update.
`BaseText`	`getVariableValue()`	Returns the value of the variable to update.
`String`	`globalInfo()`	Returns a string describing the object.
`boolean`	`isUpdatingVariables()`	Returns whether variables are being updated.
`String`	`overrideWithEnvVarTipText()`	Returns the tip text for this property.
`void`	`setEnvVariable(String value)`	Sets the name of the environment variable to use.
`void`	`setEnvVarOptional(boolean value)`	Sets whether to the environment variable is optional.
`void`	`setExpandValue(boolean value)`	Sets whether to expand the value before settting it (eg if it is made up of variables itself).
`void`	`setOverrideWithEnvVar(boolean value)`	Sets whether to override the value with the one obtained from the specified environment variable.
`void`	`setValueType(VariableValueType value)`	Sets how to interpret the value string.
`void`	`setVariableName(VariableName value)`	Sets the name of the variable to update.
`void`	`setVariableName(String value)`	Sets the name of the variable to update.
`void`	`setVariableValue(BaseText value)`	Sets the value of the variable to update.
`void`	`setVariableValue(String value)`	Sets the value of the variable to update.
`String`	`valueTypeTipText()`	Returns the tip text for this property.
`String`	`variableNameTipText()`	Returns the tip text for this property.
`String`	`variableValueTipText()`	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.AbstractStandalone
preExecute

Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor
toCommandLine

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager

- Field Detail
  - m_VariableName
```
protected VariableName m_VariableName
```
    the name of the variable.
  - m_VariableValue
```
protected BaseText m_VariableValue
```
    the value of the variable.
  - m_ValueType
```
protected VariableValueType m_ValueType
```
    how to interpret the value.
  - m_ExpandValue
```
protected boolean m_ExpandValue
```
    whether to expand the value.
  - m_OverrideWithEnvVar
```
protected boolean m_OverrideWithEnvVar
```
    whether to override using an environment variable.
  - m_EnvVariable
```
protected String m_EnvVariable
```
    the environment variable to use.
  - m_EnvVarOptional
```
protected boolean m_EnvVarOptional
```
    whether to override using an environment variable.
- Constructor Detail
  - SetVariable
```
public SetVariable()
```
    Default constructor.
  - SetVariable
```
public SetVariable(VariableName name,
                   BaseText value)
```
    Constructor for setting variable name and value.
    
    Parameters:
    
    name - the variable name
    
    value - the variable value
  - SetVariable
```
public SetVariable(String name,
                   String value)
```
    Constructor for setting variable name and value.
    
    Parameters:
    
    name - the variable name
    
    value - the variable value
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractActor
  - 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.
  - setVariableValue
```
public void setVariableValue(String value)
```
    Sets the value of the variable to update.
    
    Parameters:
    
    value - the value
  - setVariableValue
```
public void setVariableValue(BaseText value)
```
    Sets the value of the variable to update.
    
    Parameters:
    
    value - the value
  - getVariableValue
```
public BaseText getVariableValue()
```
    Returns the value of the variable to update.
    
    Returns:
    
    the value
  - variableValueTipText
```
public String variableValueTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setValueType
```
public void setValueType(VariableValueType value)
```
    Sets how to interpret the value string.
    
    Parameters:
    
    value - the type
  - getValueType
```
public VariableValueType getValueType()
```
    Returns how to interpret the value string.
    
    Returns:
    
    the type
  - valueTypeTipText
```
public String valueTypeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setExpandValue
```
public void setExpandValue(boolean value)
```
    Sets whether to expand the value before settting it (eg if it is made up of variables itself).
    
    Parameters:
    
    value - true if to expand
  - getExpandValue
```
public boolean getExpandValue()
```
    Returns whether the value gets expanded before setting it (eg if it is made up of variables itself).
    
    Returns:
    
    true if expanded
  - expandValueTipText
```
public String expandValueTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setOverrideWithEnvVar
```
public void setOverrideWithEnvVar(boolean value)
```
    Sets whether to override the value with the one obtained from the specified environment variable.
    
    Parameters:
    
    value - true if to override
  - getOverrideWithEnvVar
```
public boolean getOverrideWithEnvVar()
```
    Returns whether to override the value with the one obtained from the specified environment variable.
    
    Returns:
    
    true if to override
  - overrideWithEnvVarTipText
```
public String overrideWithEnvVarTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setEnvVariable
```
public void setEnvVariable(String value)
```
    Sets the name of the environment variable to use.
    
    Parameters:
    
    value - the name
  - getEnvVariable
```
public String getEnvVariable()
```
    Returns the name of the environment variable to use.
    
    Returns:
    
    the name
  - envVariableTipText
```
public String envVariableTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setEnvVarOptional
```
public void setEnvVarOptional(boolean value)
```
    Sets whether to the environment variable is optional. If not optional, a missing variable will generate an error.
    
    Parameters:
    
    value - true if optional
  - getEnvVarOptional
```
public boolean getEnvVarOptional()
```
    Returns whether to the environment variable is optional. If not optional, a missing variable will generate an error.
    
    Returns:
    
    true if optional
  - envVarOptionalTipText
```
public String envVarOptionalTipText()
```
    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
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the actor, which will be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface Actor
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Overrides:
    
    getQuickInfo in class AbstractActor
    
    Returns:
    
    null if no info available, otherwise short string
  - doExecute
```
protected String doExecute()
```
    Executes the flow item.
    
    Specified by:
    
    doExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message

Class SetVariable

Field Summary

Fields inherited from class adams.flow.core.AbstractActor

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.flow.core.Actor

Constructor Summary

Method Summary

Methods inherited from class adams.flow.standalone.AbstractStandalone

Methods inherited from class adams.flow.core.AbstractActor

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.flow.core.Actor

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.logging.LoggingSupporter

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

m_VariableName

m_VariableValue

m_ValueType

m_ExpandValue

m_OverrideWithEnvVar

m_EnvVariable

m_EnvVarOptional

Constructor Detail

SetVariable

SetVariable

SetVariable

Method Detail

globalInfo

defineOptions

setVariableName

setVariableName

getVariableName

variableNameTipText

setVariableValue

setVariableValue

getVariableValue

variableValueTipText

setValueType

getValueType

valueTypeTipText

setExpandValue

getExpandValue

expandValueTipText

setOverrideWithEnvVar

getOverrideWithEnvVar

overrideWithEnvVarTipText

setEnvVariable

getEnvVariable

envVariableTipText

setEnvVarOptional

getEnvVarOptional

envVarOptionalTipText

isUpdatingVariables

getQuickInfo

doExecute