org.safs.model

Class Variable

java.lang.Object

org.safs.model.Variable

public class Variable
extends java.lang.Object

An object representing a DDVariable in the SAFS framework.

DDVariableStore

We use references to Variable objects to prevent human error in keying in DDVariable names and references.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VAR_IDENTIFIER '^'

Constructor Summary

Constructors

Constructor and Description
Variable(java.lang.String varname) Create a new Variable object with the given varname.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAssignment(java.lang.String expression) "^varname=expression" -- Returns an assignment version of this variable.
java.lang.String	getName() "varname" -- Returns the name of this variable with no leading variable identifier('^').
java.lang.String	getReference() "^varname" -- Returns a dereferencing version of this variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_VAR_IDENTIFIER

public static final java.lang.String DEFAULT_VAR_IDENTIFIER

'^'

See Also:

Constant Field Values

Constructor Detail

Variable

public Variable(java.lang.String varname)

Create a new Variable object with the given varname. Variable names cannot contain spaces, can contain alpha and numeric characters, and can contain a few special characters like '.'(period) and '_'(underscore).

Note: Special characters should NOT be used where they may conflict with the separator used in your table records.

SAFS DDVariable names are NOT case-sensitive, so variables named 'varname' and 'VARNAME' reference the same variable.

Parameters:

varname - valid DDVariable name (cannot be null or contain whitespace). The name provided will be trim()'d prior to use.\

Throws:

java.lang.IllegalArgumentException - if null or zero-length name is specified

Method Detail

getName

public java.lang.String getName()

"varname" -- Returns the name of this variable with no leading variable identifier('^'). This is used at times when only the name of the variable is needed.

Some SAFS commands want the names of variables.
Attempting to provide the variable name with the variable identifier prefix will result in providing the variable's value instead of its name at runtime.

Returns:

varname

getReference

public java.lang.String getReference()

"^varname" -- Returns a dereferencing version of this variable. This is used in SAFS records to retrieve the SAFS runtime value of the variable.

Returns:

^varname

getAssignment

public java.lang.String getAssignment(java.lang.String expression)

"^varname=expression" -- Returns an assignment version of this variable. This is used in SAFS records to assign a new value to the variable at SAFS runtime. Remember to wrap the expression in double-quotes prior to this call if it contains SAFS expression operators or leading or trailing whitespace that must be treated as literal text.

Returns:

^varname=expression