org.safs.model.commands

Class DDDriverStringCommands

java.lang.Object

org.safs.model.commands.DDDriverStringCommands

public class DDDriverStringCommands
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLEANSTRING_KEYWORD "CleanString"
static java.lang.String	COMPARE_KEYWORD "Compare"
static java.lang.String	CONCATENATE_KEYWORD "Concatenate"
static java.lang.String	GETFIELD_KEYWORD "GetField"
static java.lang.String	GETFIELDCOUNT_KEYWORD "GetFieldCount"
static java.lang.String	GETFIXEDWIDTHFIELD_KEYWORD "GetFixedWidthField"
static java.lang.String	GETMULTIDELIMITEDFIELD_KEYWORD "GetMultiDelimitedField"
static java.lang.String	GETMULTIDELIMITEDFIELDCOUNT_KEYWORD "GetMultiDelimitedFieldCount"
static java.lang.String	GETNEXTDELIMITERINDEX_KEYWORD "GetNextDelimiterIndex"
static java.lang.String	GETREDELIMITEDFIELD_KEYWORD "GetREDelimitedField"
static java.lang.String	GETREDELIMITEDFIELDCOUNT_KEYWORD "GetREDelimitedFieldCount"
static java.lang.String	GETSUBSTRINGINSTRING_KEYWORD "GetSubstringsInString"
static java.lang.String	GETSYSTEMENVIRON_KEYWORD "GetSystemEnviron"
static java.lang.String	GETSYSTEMUSER_KEYWORD "GetSystemUser"
static java.lang.String	GETTRIMMEDFIELD_KEYWORD "GetTrimmedField"
static java.lang.String	INDEX_KEYWORD "Index"
static java.lang.String	LEFT_KEYWORD "Left"
static java.lang.String	LEFTTRIM_KEYWORD "LeftTrim"
static java.lang.String	LENGTH_KEYWORD "Length"
static java.lang.String	REPLACE_KEYWORD "Replace"
static java.lang.String	RIGHT_KEYWORD "Right"
static java.lang.String	RIGHTTRIM_KEYWORD "RightTrim"
static java.lang.String	SUBSTRING_KEYWORD "SubString"
static java.lang.String	TOLOWERCASE_KEYWORD "ToLowerCase"
static java.lang.String	TOUPPERCASE_KEYWORD "ToUpperCase"
static java.lang.String	TRIM_KEYWORD "Trim"

Method Summary

Modifier and Type	Method and Description
static DriverCommand	cleanString(java.lang.String[] parameters) CleanString, for each char in string: if ((char .gt.
static DriverCommand	cleanString(java.lang.String sourceString, java.lang.String resultVar) CleanString, for each char in string: if ((char .gt.
static DriverCommand	compare(java.lang.String[] parameters) Compares two strings and returns an integer specifying the result of the comparison.
static DriverCommand	compare(java.lang.String sourceString, java.lang.String dstString, java.lang.String resultVar, java.lang.String regexMatch) Compares two strings and returns an integer specifying the result of the comparison.
static DriverCommand	concatenate(java.lang.String[] parameters) Concatenate String1 with String2 and returns concatenated string.
static DriverCommand	concatenate(java.lang.String string1, java.lang.String string2, java.lang.String resultVar) Concatenate String1 with String2 and returns concatenated string.
static DriverCommand	getField(java.lang.String[] parameters) GetField, get a field out of a string using specified delimiter(s).
static DriverCommand	getField(java.lang.String inputString, java.lang.String index, java.lang.String delimiter, java.lang.String resultVar) GetField, get a field out of a string using specified delimiter(s).
static DriverCommand	getFieldCount(java.lang.String[] parameters) GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getFieldCount(java.lang.String string1, java.lang.String startindex, java.lang.String delimiters, java.lang.String resultVar) GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getFixedWidthField(java.lang.String[] parameters) GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
static DriverCommand	getFixedWidthField(java.lang.String sourceString, java.lang.String fieldID, java.lang.String fixedwidth, java.lang.String resultVar) GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
static DDDriverStringCommands	getInstance() public Singleton to access class static methods via instance
static DriverCommand	getMultiDelimitedField(java.lang.String[] parameters) Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex.
static DriverCommand	getMultiDelimitedField(java.lang.String sourceString, java.lang.String fieldID, java.lang.String startIndex, java.lang.String delimiters, java.lang.String resultVar) Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex.
static DriverCommand	getMultiDelimitedFieldCount(java.lang.String[] parameters) Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getMultiDelimitedFieldCount(java.lang.String string1, java.lang.String startIndex, java.lang.String delimiters, java.lang.String resultVar) Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getNextDelimiterIndex(java.lang.String[] parameters) GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters.
static DriverCommand	getNextDelimiterIndex(java.lang.String string1, java.lang.String startindex, java.lang.String delimiters, java.lang.String resultVar) GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters.
static DriverCommand	getREDelimitedField(java.lang.String[] parameters) GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getREDelimitedField(java.lang.String inputString, java.lang.String index, java.lang.String regExp, java.lang.String resultVar) GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getREDelimitedFieldCount(java.lang.String[] parameters) GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getREDelimitedFieldCount(java.lang.String inputString, java.lang.String index, java.lang.String regExp, java.lang.String resultVar) GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getSubstringsInString(java.lang.String[] parameters) Extract dynamic substring from a string using regular expressions.
static DriverCommand	getSubstringsInString(java.lang.String string, java.lang.String regexStart, java.lang.String regexStop, java.lang.String varName) Extract dynamic substring from a string using regular expressions.
static DriverCommand	getSystemEnviron(java.lang.String[] parameters) GetSystemEnviron, get a system environment variable value
static DriverCommand	getSystemEnviron(java.lang.String string1, java.lang.String resultVar) GetSystemEnviron, get a system environment variable value
static DriverCommand	getSystemUser(java.lang.String resultVar) Get the USERID of the currently logged on user as stored in System Environment variables.
static DriverCommand	getTrimmedField(java.lang.String[] parameters) GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
static DriverCommand	getTrimmedField(java.lang.String string1, java.lang.String index, java.lang.String delimiter, java.lang.String resultVar) GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
static DriverCommand	index(java.lang.String[] parameters) Returns the position of the first occurrence of one string within another string.
static DriverCommand	index(java.lang.String start, java.lang.String sourceString, java.lang.String findString, java.lang.String resultVar) Returns the position of the first occurrence of one string within another string.
static DriverCommand	left(java.lang.String[] parameters) Returns a string of a specified number of characters copied from the beginning of another string.
static DriverCommand	left(java.lang.String sourceString, java.lang.String length, java.lang.String resultVar) Returns a string of a specified number of characters copied from the beginning of another string.
static DriverCommand	leftTrim(java.lang.String[] parameters) A new string trimmed of leading tabs and spaces.
static DriverCommand	leftTrim(java.lang.String sourceString, java.lang.String resultVar) A new string trimmed of leading tabs and spaces.
static DriverCommand	length(java.lang.String[] parameters) Returns the length of a string or variable.
static DriverCommand	length(java.lang.String sourceString, java.lang.String resultVar) Returns the length of a string or variable.
static DriverCommand	replace(java.lang.String[] parameters) Replace 'find' substring with 'replace' substring
static DriverCommand	replace(java.lang.String sourceString, java.lang.String findString, java.lang.String replaceString, java.lang.String resultVar) Replace 'find' substring with 'replace' substring
static DriverCommand	right(java.lang.String[] parameters) Returns a string of a specified number of characters copied from the end of another string.
static DriverCommand	right(java.lang.String sourceString, java.lang.String length, java.lang.String resultVar) Returns a string of a specified number of characters copied from the end of another string.
static DriverCommand	rightTrim(java.lang.String[] parameters) A new string trimmed of trailing tabs and spaces.
static DriverCommand	rightTrim(java.lang.String sourceString, java.lang.String resultVar) A new string trimmed of trailing tabs and spaces.
static DriverCommand	subString(java.lang.String[] parameters) Returns a portion of a string based on character index.
static DriverCommand	subString(java.lang.String sourceString, java.lang.String start, java.lang.String length, java.lang.String resultVar) Returns a portion of a string based on character index.
static DriverCommand	toLowerCase(java.lang.String[] parameters) Returns a copy of a string, with all letters converted to lowercase.
static DriverCommand	toLowerCase(java.lang.String sourceString, java.lang.String resultVar) Returns a copy of a string, with all letters converted to lowercase.
static DriverCommand	toUpperCase(java.lang.String[] parameters) Returns a copy of a string after converting all letters to uppercase.
static DriverCommand	toUpperCase(java.lang.String sourceString, java.lang.String resultVar) Returns a copy of a string after converting all letters to uppercase.
static DriverCommand	trim(java.lang.String[] parameters) A new string trimmed of leading and trailing tabs and spaces.
static DriverCommand	trim(java.lang.String sourceString, java.lang.String resultVar) A new string trimmed of leading and trailing tabs and spaces.

Methods inherited from class java.lang.Object

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

Field Detail

CLEANSTRING_KEYWORD

public static final java.lang.String CLEANSTRING_KEYWORD

"CleanString"

See Also:

Constant Field Values

COMPARE_KEYWORD

public static final java.lang.String COMPARE_KEYWORD

"Compare"

See Also:

Constant Field Values

CONCATENATE_KEYWORD

public static final java.lang.String CONCATENATE_KEYWORD

"Concatenate"

See Also:

Constant Field Values

GETFIELD_KEYWORD

public static final java.lang.String GETFIELD_KEYWORD

"GetField"

See Also:

Constant Field Values

GETFIELDCOUNT_KEYWORD

public static final java.lang.String GETFIELDCOUNT_KEYWORD

"GetFieldCount"

See Also:

Constant Field Values

GETFIXEDWIDTHFIELD_KEYWORD

public static final java.lang.String GETFIXEDWIDTHFIELD_KEYWORD

"GetFixedWidthField"

See Also:

Constant Field Values

GETMULTIDELIMITEDFIELD_KEYWORD

public static final java.lang.String GETMULTIDELIMITEDFIELD_KEYWORD

"GetMultiDelimitedField"

See Also:

Constant Field Values

GETMULTIDELIMITEDFIELDCOUNT_KEYWORD

public static final java.lang.String GETMULTIDELIMITEDFIELDCOUNT_KEYWORD

"GetMultiDelimitedFieldCount"

See Also:

Constant Field Values

GETNEXTDELIMITERINDEX_KEYWORD

public static final java.lang.String GETNEXTDELIMITERINDEX_KEYWORD

"GetNextDelimiterIndex"

See Also:

Constant Field Values

GETREDELIMITEDFIELD_KEYWORD

public static final java.lang.String GETREDELIMITEDFIELD_KEYWORD

"GetREDelimitedField"

See Also:

Constant Field Values

GETREDELIMITEDFIELDCOUNT_KEYWORD

public static final java.lang.String GETREDELIMITEDFIELDCOUNT_KEYWORD

"GetREDelimitedFieldCount"

See Also:

Constant Field Values

GETSUBSTRINGINSTRING_KEYWORD

public static final java.lang.String GETSUBSTRINGINSTRING_KEYWORD

"GetSubstringsInString"

See Also:

Constant Field Values

GETSYSTEMENVIRON_KEYWORD

public static final java.lang.String GETSYSTEMENVIRON_KEYWORD

"GetSystemEnviron"

See Also:

Constant Field Values

GETSYSTEMUSER_KEYWORD

public static final java.lang.String GETSYSTEMUSER_KEYWORD

"GetSystemUser"

See Also:

Constant Field Values

GETTRIMMEDFIELD_KEYWORD

public static final java.lang.String GETTRIMMEDFIELD_KEYWORD

"GetTrimmedField"

See Also:

Constant Field Values

INDEX_KEYWORD

public static final java.lang.String INDEX_KEYWORD

"Index"

See Also:

Constant Field Values

LEFT_KEYWORD

public static final java.lang.String LEFT_KEYWORD

"Left"

See Also:

Constant Field Values

LEFTTRIM_KEYWORD

public static final java.lang.String LEFTTRIM_KEYWORD

"LeftTrim"

See Also:

Constant Field Values

LENGTH_KEYWORD

public static final java.lang.String LENGTH_KEYWORD

"Length"

See Also:

Constant Field Values

REPLACE_KEYWORD

public static final java.lang.String REPLACE_KEYWORD

"Replace"

See Also:

Constant Field Values

RIGHT_KEYWORD

public static final java.lang.String RIGHT_KEYWORD

"Right"

See Also:

Constant Field Values

RIGHTTRIM_KEYWORD

public static final java.lang.String RIGHTTRIM_KEYWORD

"RightTrim"

See Also:

Constant Field Values

SUBSTRING_KEYWORD

public static final java.lang.String SUBSTRING_KEYWORD

"SubString"

See Also:

Constant Field Values

TOLOWERCASE_KEYWORD

public static final java.lang.String TOLOWERCASE_KEYWORD

"ToLowerCase"

See Also:

Constant Field Values

TOUPPERCASE_KEYWORD

public static final java.lang.String TOUPPERCASE_KEYWORD

"ToUpperCase"

See Also:

Constant Field Values

TRIM_KEYWORD

public static final java.lang.String TRIM_KEYWORD

"Trim"

See Also:

Constant Field Values

Method Detail

getInstance

public static DDDriverStringCommands getInstance()

public Singleton to access class static methods via instance

cleanString

public static DriverCommand cleanString(java.lang.String sourceString,
                                        java.lang.String resultVar)

          CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it,
          otherwise turn it into a space
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

cleanString

public static DriverCommand cleanString(java.lang.String[] parameters)

          CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it,
          otherwise turn it into a space
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

compare

public static DriverCommand compare(java.lang.String sourceString,
                                    java.lang.String dstString,
                                    java.lang.String resultVar,
                                    java.lang.String regexMatch)

          Compares two strings and returns an integer specifying the
          result of the comparison.
          The java version returns 'true' or 'false' as the result.
        
          For java version, if the parameter 'regexMatch' is true, then
          the parameter 'dstString' is considered as regular expression.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

sourceString - Optional:NO The source string (could come from a ^variable) to compare.

dstString - Optional:NO The destination string (could come from a ^variable) to compare.

resultVar - Optional:NO the resultVar to place the result of the operation into

regexMatch - Optional:YES DefaultVal:false Indicates if the comparison is in regex way.

compare

public static DriverCommand compare(java.lang.String[] parameters)

          Compares two strings and returns an integer specifying the
          result of the comparison.
          The java version returns 'true' or 'false' as the result.
        
          For java version, if the parameter 'regexMatch' is true, then
          the parameter 'dstString' is considered as regular expression.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO The source string (could come from a ^variable) to compare.
dstString -- Optional:NO The destination string (could come from a ^variable) to compare.
resultVar -- Optional:NO the resultVar to place the result of the operation into
regexMatch -- Optional:YES DefaultVal:false Indicates if the comparison is in regex way.

concatenate

public static DriverCommand concatenate(java.lang.String string1,
                                        java.lang.String string2,
                                        java.lang.String resultVar)

          Concatenate String1 with String2 and returns concatenated string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO string1 (could come from a ^variable)

string2 - Optional:NO string2 (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

concatenate

public static DriverCommand concatenate(java.lang.String[] parameters)

          Concatenate String1 with String2 and returns concatenated string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string1 -- Optional:NO string1 (could come from a ^variable)
string2 -- Optional:NO string2 (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

getField

public static DriverCommand getField(java.lang.String inputString,
                                     java.lang.String index,
                                     java.lang.String delimiter,
                                     java.lang.String resultVar)

          GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputString - Optional:NO The input string which contains the field to be returned

index - Optional:NO 0-based index of which field to return

delimiter - Optional:NO delimiter(s) - one or more single characters used as delimiters

resultVar - Optional:NO the variable name to store the returned field in

getField

public static DriverCommand getField(java.lang.String[] parameters)

          GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

inputString -- Optional:NO The input string which contains the field to be returned
index -- Optional:NO 0-based index of which field to return
delimiter -- Optional:NO delimiter(s) - one or more single characters used as delimiters
resultVar -- Optional:NO the variable name to store the returned field in

getFieldCount

public static DriverCommand getFieldCount(java.lang.String string1,
                                          java.lang.String startindex,
                                          java.lang.String delimiters,
                                          java.lang.String resultVar)

          GetFieldCount, Finds the count of all fields within the
          inputRecord found from startindex to the end of the inputRecord.  
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO String1 to parse and count fields

startindex - Optional:NO 0-based startindex for parsing the string.

delimiters - Optional:NO delimiters -- each character is treated as a separate delimiter.

resultVar - Optional:NO the resultVar to place the result of the operation into

getFieldCount

public static DriverCommand getFieldCount(java.lang.String[] parameters)

          GetFieldCount, Finds the count of all fields within the
          inputRecord found from startindex to the end of the inputRecord.  
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string1 -- Optional:NO String1 to parse and count fields
startindex -- Optional:NO 0-based startindex for parsing the string.
delimiters -- Optional:NO delimiters -- each character is treated as a separate delimiter.
resultVar -- Optional:NO the resultVar to place the result of the operation into

getFixedWidthField

public static DriverCommand getFixedWidthField(java.lang.String sourceString,
                                               java.lang.String fieldID,
                                               java.lang.String fixedwidth,
                                               java.lang.String resultVar)

          GetFixedWidthField, Given an Input of fixed-width
          fields, return the nth(FieldID) Field  in the record.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

fieldID - Optional:NO 0-based field to retrieve. from 0.

fixedwidth - Optional:NO the fixedwidth alotted for each field in the record

resultVar - Optional:NO the resultVar to place the result of the operation into

getFixedWidthField

public static DriverCommand getFixedWidthField(java.lang.String[] parameters)

          GetFixedWidthField, Given an Input of fixed-width
          fields, return the nth(FieldID) Field  in the record.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
fieldID -- Optional:NO 0-based field to retrieve. from 0.
fixedwidth -- Optional:NO the fixedwidth alotted for each field in the record
resultVar -- Optional:NO the resultVar to place the result of the operation into

getMultiDelimitedField

public static DriverCommand getMultiDelimitedField(java.lang.String sourceString,
                                                   java.lang.String fieldID,
                                                   java.lang.String startIndex,
                                                   java.lang.String delimiters,
                                                   java.lang.String resultVar)

Given a sourceString of delimited fields, return the nth(FieldID) Field
      in the record from startIndex.  The startIndex and fieldID are 1 based. 
        Returns a specific field from the source string found from
        startindex to the end of the sourceString.  The field and index are 1-based.
   
      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the sourceString 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO Source string in which to search for first delimited character

fieldID - Optional:NO The one based index of the field to find and return.

startIndex - Optional:NO Integer (1-based) start position for search in sourceString

delimiters - Optional:NO String list of delimiters to find

resultVar - Optional:NO Name of DDVariable that will receive the result.

getMultiDelimitedField

public static DriverCommand getMultiDelimitedField(java.lang.String[] parameters)

Given a sourceString of delimited fields, return the nth(FieldID) Field
      in the record from startIndex.  The startIndex and fieldID are 1 based. 
        Returns a specific field from the source string found from
        startindex to the end of the sourceString.  The field and index are 1-based.
   
      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the sourceString 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO Source string in which to search for first delimited character
fieldID -- Optional:NO The one based index of the field to find and return.
startIndex -- Optional:NO Integer (1-based) start position for search in sourceString
delimiters -- Optional:NO String list of delimiters to find
resultVar -- Optional:NO Name of DDVariable that will receive the result.

getMultiDelimitedFieldCount

public static DriverCommand getMultiDelimitedFieldCount(java.lang.String string1,
                                                        java.lang.String startIndex,
                                                        java.lang.String delimiters,
                                                        java.lang.String resultVar)

Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Blank fields count The next field starts at the next
        character index even if that char is also a delimiter.
        If the last character in the inputRecord is a delimiter, then the
        field it terminates is the last field in the inputRecord.

      Field #1 index is always the same as startindex--even if the character at 
      the startindex position is a delimiter.

      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the inputRecord 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO Source String in which to search for first delimited character

startIndex - Optional:NO Integer (1-based) start position for search in inputRecord

delimiters - Optional:NO String list of delimiters to find

resultVar - Optional:NO Name of DDVariable to receive the result

getMultiDelimitedFieldCount

public static DriverCommand getMultiDelimitedFieldCount(java.lang.String[] parameters)

Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Blank fields count The next field starts at the next
        character index even if that char is also a delimiter.
        If the last character in the inputRecord is a delimiter, then the
        field it terminates is the last field in the inputRecord.

      Field #1 index is always the same as startindex--even if the character at 
      the startindex position is a delimiter.

      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the inputRecord 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string1 -- Optional:NO Source String in which to search for first delimited character
startIndex -- Optional:NO Integer (1-based) start position for search in inputRecord
delimiters -- Optional:NO String list of delimiters to find
resultVar -- Optional:NO Name of DDVariable to receive the result

getNextDelimiterIndex

public static DriverCommand getNextDelimiterIndex(java.lang.String string1,
                                                  java.lang.String startindex,
                                                  java.lang.String delimiters,
                                                  java.lang.String resultVar)

          GetNextDelimiterIndex, Finds the index of the first
          character matching one of the provided delimiter characters.
          The search begins at startindex within the inputRecord. 
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO String1 to parse for field delimiters

startindex - Optional:NO 0-based startindex to begin parsing the string.

delimiters - Optional:NO delimiters -- each character is treated as a separate delimiter.

resultVar - Optional:NO the resultVar to place the result of the operation into

getNextDelimiterIndex

public static DriverCommand getNextDelimiterIndex(java.lang.String[] parameters)

          GetNextDelimiterIndex, Finds the index of the first
          character matching one of the provided delimiter characters.
          The search begins at startindex within the inputRecord. 
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string1 -- Optional:NO String1 to parse for field delimiters
startindex -- Optional:NO 0-based startindex to begin parsing the string.
delimiters -- Optional:NO delimiters -- each character is treated as a separate delimiter.
resultVar -- Optional:NO the resultVar to place the result of the operation into

getREDelimitedField

public static DriverCommand getREDelimitedField(java.lang.String inputString,
                                                java.lang.String index,
                                                java.lang.String regExp,
                                                java.lang.String resultVar)

          GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputString - Optional:NO The input string to analyze.

index - Optional:NO 1-based index of the field to return from the input string.

regExp - Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.

resultVar - Optional:NO resultVar contains the requested field from the input string.

getREDelimitedField

public static DriverCommand getREDelimitedField(java.lang.String[] parameters)

          GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

inputString -- Optional:NO The input string to analyze.
index -- Optional:NO 1-based index of the field to return from the input string.
regExp -- Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.
resultVar -- Optional:NO resultVar contains the requested field from the input string.

getREDelimitedFieldCount

public static DriverCommand getREDelimitedFieldCount(java.lang.String inputString,
                                                     java.lang.String index,
                                                     java.lang.String regExp,
                                                     java.lang.String resultVar)

          GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputString - Optional:NO The input string to analyze.

index - Optional:NO 0-based index of where to start the analysis from. The index should be less than or equal to the length of the input string.

regExp - Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.

resultVar - Optional:NO resultVar contains the number of fields in the input string.

getREDelimitedFieldCount

public static DriverCommand getREDelimitedFieldCount(java.lang.String[] parameters)

          GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

inputString -- Optional:NO The input string to analyze.
index -- Optional:NO 0-based index of where to start the analysis from. The index should be less than or equal to the length of the input string.
regExp -- Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.
resultVar -- Optional:NO resultVar contains the number of fields in the input string.

getSubstringsInString

public static DriverCommand getSubstringsInString(java.lang.String string,
                                                  java.lang.String regexStart,
                                                  java.lang.String regexStop,
                                                  java.lang.String varName)

 
                  Extract dynamic substring from a string using regular expressions.
                
                  
                  This command sets a DDVariable for each substring formed between regexstart and regexstop (1 match per string, currently).  Both regexstart and regexstop must be valid, non-empty strings or no matching substring will be found.
                  
                  The string is parsed, searching the substring between regexstart and regexstop matches.
                  
                  When a match is found, the string between regexstart and regexstop is saved in a newly created DDVariable with the name given in varname.
                  
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

string - Optional:NO String to search for substring.

regexStart - Optional:NO The starting regular expression. Should not be empty.

regexStop - Optional:NO The stopping regular expression. Should not be empty.

varName - Optional:NO The name of the variable to contain the substring.

getSubstringsInString

public static DriverCommand getSubstringsInString(java.lang.String[] parameters)

 
                  Extract dynamic substring from a string using regular expressions.
                
                  
                  This command sets a DDVariable for each substring formed between regexstart and regexstop (1 match per string, currently).  Both regexstart and regexstop must be valid, non-empty strings or no matching substring will be found.
                  
                  The string is parsed, searching the substring between regexstart and regexstop matches.
                  
                  When a match is found, the string between regexstart and regexstop is saved in a newly created DDVariable with the name given in varname.
                  
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string -- Optional:NO String to search for substring.
regexStart -- Optional:NO The starting regular expression. Should not be empty.
regexStop -- Optional:NO The stopping regular expression. Should not be empty.
varName -- Optional:NO The name of the variable to contain the substring.

getSystemEnviron

public static DriverCommand getSystemEnviron(java.lang.String string1,
                                             java.lang.String resultVar)

          GetSystemEnviron, get a system environment variable value
            

Supporting Engines:

• Rational RobotJ
• Rational Robot
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

string1 - Optional:NO String1

resultVar - Optional:NO the resultVar to place the result of the operation into

getSystemEnviron

public static DriverCommand getSystemEnviron(java.lang.String[] parameters)

          GetSystemEnviron, get a system environment variable value
            

Supporting Engines:

• Rational RobotJ
• Rational Robot
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string1 -- Optional:NO String1
resultVar -- Optional:NO the resultVar to place the result of the operation into

getSystemUser

public static DriverCommand getSystemUser(java.lang.String resultVar)

          Get the USERID of the currently logged on user as stored in System Environment variables.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

resultVar - Optional:NO the resultVar to place the USERID into

getTrimmedField

public static DriverCommand getTrimmedField(java.lang.String string1,
                                            java.lang.String index,
                                            java.lang.String delimiter,
                                            java.lang.String resultVar)

          GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO string1

index - Optional:NO 0-based index of which field to grab

delimiter - Optional:NO delimiter

resultVar - Optional:NO the resultVar to place the result of the operation into

getTrimmedField

public static DriverCommand getTrimmedField(java.lang.String[] parameters)

          GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

string1 -- Optional:NO string1
index -- Optional:NO 0-based index of which field to grab
delimiter -- Optional:NO delimiter
resultVar -- Optional:NO the resultVar to place the result of the operation into

index

public static DriverCommand index(java.lang.String start,
                                  java.lang.String sourceString,
                                  java.lang.String findString,
                                  java.lang.String resultVar)

          Returns the position of the first occurrence of one string
          within another string. -1 if not found at all
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

start - Optional:NO 0-based starting offset of the sourceString to search

sourceString - Optional:NO sourceString (could come from a ^variable)

findString - Optional:NO findString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

index

public static DriverCommand index(java.lang.String[] parameters)

          Returns the position of the first occurrence of one string
          within another string. -1 if not found at all
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

start -- Optional:NO 0-based starting offset of the sourceString to search
sourceString -- Optional:NO sourceString (could come from a ^variable)
findString -- Optional:NO findString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

left

public static DriverCommand left(java.lang.String sourceString,
                                 java.lang.String length,
                                 java.lang.String resultVar)

          Returns a string of a specified number of characters copied from the beginning of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

length - Optional:NO number of chars to copy

resultVar - Optional:NO the resultVar to place the result of the operation into

left

public static DriverCommand left(java.lang.String[] parameters)

          Returns a string of a specified number of characters copied from the beginning of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
length -- Optional:NO number of chars to copy
resultVar -- Optional:NO the resultVar to place the result of the operation into

leftTrim

public static DriverCommand leftTrim(java.lang.String sourceString,
                                     java.lang.String resultVar)

          A new string trimmed of leading tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

leftTrim

public static DriverCommand leftTrim(java.lang.String[] parameters)

          A new string trimmed of leading tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

length

public static DriverCommand length(java.lang.String sourceString,
                                   java.lang.String resultVar)

          Returns the length of a string or variable.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the length operation into

length

public static DriverCommand length(java.lang.String[] parameters)

          Returns the length of a string or variable.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the length operation into

replace

public static DriverCommand replace(java.lang.String sourceString,
                                    java.lang.String findString,
                                    java.lang.String replaceString,
                                    java.lang.String resultVar)

          Replace 'find' substring with 'replace' substring
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

findString - Optional:NO findString (could come from a ^variable)

replaceString - Optional:NO replaceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

replace

public static DriverCommand replace(java.lang.String[] parameters)

          Replace 'find' substring with 'replace' substring
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
findString -- Optional:NO findString (could come from a ^variable)
replaceString -- Optional:NO replaceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

right

public static DriverCommand right(java.lang.String sourceString,
                                  java.lang.String length,
                                  java.lang.String resultVar)

          Returns a string of a specified number of characters copied from the end of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

length - Optional:NO length

resultVar - Optional:NO the resultVar to place the result of the operation into

right

public static DriverCommand right(java.lang.String[] parameters)

          Returns a string of a specified number of characters copied from the end of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
length -- Optional:NO length
resultVar -- Optional:NO the resultVar to place the result of the operation into

rightTrim

public static DriverCommand rightTrim(java.lang.String sourceString,
                                      java.lang.String resultVar)

          A new string trimmed of trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

rightTrim

public static DriverCommand rightTrim(java.lang.String[] parameters)

          A new string trimmed of trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

subString

public static DriverCommand subString(java.lang.String sourceString,
                                      java.lang.String start,
                                      java.lang.String length,
                                      java.lang.String resultVar)

          Returns a portion of a string based on character index.
        
          The substring  to retrieve starts at the specified start
          character index and ends after the specified number of characters have been copied.  If the number of characters to copy is not provided, then we will return all characters after the start index.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

start - Optional:NO starting 0-based offset character position

length - Optional:YES number of chars to copy. If not provided or less than 1 then all characters after the start index will be retrieved.

resultVar - Optional:NO the resultVar to place the result of the operation into

subString

public static DriverCommand subString(java.lang.String[] parameters)

          Returns a portion of a string based on character index.
        
          The substring  to retrieve starts at the specified start
          character index and ends after the specified number of characters have been copied.  If the number of characters to copy is not provided, then we will return all characters after the start index.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
start -- Optional:NO starting 0-based offset character position
length -- Optional:YES number of chars to copy. If not provided or less than 1 then all characters after the start index will be retrieved.
resultVar -- Optional:NO the resultVar to place the result of the operation into

toLowerCase

public static DriverCommand toLowerCase(java.lang.String sourceString,
                                        java.lang.String resultVar)

          Returns a copy of a string, with all letters converted to lowercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

toLowerCase

public static DriverCommand toLowerCase(java.lang.String[] parameters)

          Returns a copy of a string, with all letters converted to lowercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

toUpperCase

public static DriverCommand toUpperCase(java.lang.String sourceString,
                                        java.lang.String resultVar)

          Returns a copy of a string after converting all letters to uppercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

toUpperCase

public static DriverCommand toUpperCase(java.lang.String[] parameters)

          Returns a copy of a string after converting all letters to uppercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

trim

public static DriverCommand trim(java.lang.String sourceString,
                                 java.lang.String resultVar)

          A new string trimmed of leading and trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

trim

public static DriverCommand trim(java.lang.String[] parameters)

          A new string trimmed of leading and trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into