DDDriverStringCommands::CleanString
CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it,
otherwise turn it into a space
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Compare
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.
Fields: [ ]=
Optional with Default Value
-
sourceString
The source string (could come from a ^variable) to compare.
-
dstString
The destination string (could come from a ^variable) to compare.
This is normally a simple string;
But it could be a regular expression if the parameter 'regexMatch' is true.
Do NOT forget the leading symbol ^ and the ending symbol $ if
the whole string should be considered; Without them, if a sub-string of the 'sourceString'
can match the regex pattern, then it is considered matched.
-
resultVar
the resultVar to place the result of the operation into
- [ regexMatch = false ]
Indicates if the comparison is in regex way.
This parameter is optional, the default value is false.
If this is true, then the parameter 'dstString' should be provided with a regular expression.
Else if this is false or not provided, the parameter 'dstString' will be treated as a normal
string even if it is provided with a regular expression.
Examples:
-
C, Compare, "abc", "abcd", var
variable 'var' should contain 'false'
-
C, Compare, "Hi, Hello World with happy", "[H|h]ello [W|w]orld", var, true
variable 'var' should contain 'true', as sub-string "Hello World" of the source string
"Hi, Hello World with happy" can match the regex pattern "[H|h]ello [W|w]orld"
-
C, Compare, "Hi, Hello World with happy", "^[H|h]ello [W|w]orld$", var, true
variable 'var' should contain 'false'. With leading symbol ^ and ending symbol $,
it is expected that the whole string of "Hi, Hello World with happy" matches
with the regex pattern "^[H|h]ello [W|w]orld$", but it does not unfortunately.
[How To Read This Reference]
DDDriverStringCommands::Concatenate
Concatenate String1 with String2 and returns concatenated string.
Fields: [ ]=
Optional with Default Value
-
string1
string1 (could come from a ^variable)
-
string2
string2 (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetField
GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
Fields: [ ]=
Optional with Default Value
-
InputString
The input string which contains the field to be returned
-
index
0-based index of which field to return
-
delimiter
delimiter(s) - one or more single characters used as delimiters
-
resultVar
the variable name to store the returned field in
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetFieldCount
GetFieldCount, Finds the count of all fields within the
inputRecord found from startindex to the end of the inputRecord.
Fields: [ ]=
Optional with Default Value
-
String1
String1 to parse and count fields
-
startindex
0-based startindex for parsing the string.
-
delimiters
delimiters -- each character is treated as a separate delimiter.
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetFixedWidthField
GetFixedWidthField, Given an Input of fixed-width
fields, return the nth(FieldID) Field in the record.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
fieldID
0-based field to retrieve.
from 0.
-
fixedwidth
the fixedwidth alotted for each field in the record
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetMultiDelimitedField
Given a sourceString of delimited fields, return the nth(FieldID) Field
in the record from startIndex. The startIndex and fieldID are 1 based.
Fields: [ ]=
Optional with Default Value
-
sourceString
Source string in which to search for first delimited character
-
FieldID
The one based index of the field to find and return.
-
StartIndex
Integer (1-based) start position for search in sourceString
-
Delimiters
String list of delimiters to find
-
ResultVar
Name of DDVariable that will receive the result.
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetMultiDelimitedFieldCount
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.
Fields: [ ]=
Optional with Default Value
-
String1
Source String in which to search for first delimited character
-
StartIndex
Integer (1-based) start position for search in inputRecord
-
Delimiters
String list of delimiters to find
-
ResultVar
Name of DDVariable to receive the result
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetNextDelimiterIndex
GetNextDelimiterIndex, Finds the index of the first
character matching one of the provided delimiter characters.
The search begins at startindex within the inputRecord.
Fields: [ ]=
Optional with Default Value
-
String1
String1 to parse for field delimiters
-
startindex
0-based startindex to begin parsing the string.
-
delimiters
delimiters -- each character is treated as a separate delimiter.
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetREDelimitedField
GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
Fields: [ ]=
Optional with Default Value
-
InputString
The input string to analyze.
-
index
1-based index of the field to return from the input string.
-
RegExp
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
resultVar contains the requested field from the input string.
Examples:
-
C, GetREDelimitedField, "All is well in the world", 4, "\s+", var
This is equivalent to asking for one of the non-blank fields in the string. Variable 'var' should contain "in" after this is run.
-
C, GetREDelimitedField, "RedXXOrangeXXYellowXXGreenXXBlueXXIndigoXXViolet", 2, "XX", var
This uses the string "XX" as the delimiter. Variable 'var' should contain "Orange" after this is run.
-
C, GetREDelimitedField, "a|b&cd-efghi", 3, "[\|&\-g]", var
variable 'var' should contain "cd" after this is run. Fields in the string are: "a", "b", "cd", "ef", "hi".
[How To Read This Reference]
DDDriverStringCommands::GetREDelimitedFieldCount
GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
Fields: [ ]=
Optional with Default Value
-
InputString
The input string to analyze.
-
index
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
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
resultVar contains the number of fields in the input string.
Examples:
-
C, GetREDelimitedFieldCount, "All is well in the world", 4, "\s+", var
This is equivalent to asking for the count of non-blank fields in the string. Variable 'var' should contain 6 after this is run.
-
C, GetREDelimitedFieldCount, "a|b&cd-efghi", 0, "[\|&\-g]", var
variable 'var' should contain 5 after this is run. Fields are: "a", "b", "cd", "ef", "hi".
[How To Read This Reference]
DDDriverStringCommands::GetSubstringsInString
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.
Fields: [ ]=
Optional with Default Value
-
String
String to search for substring.
-
RegexStart
The starting regular expression. Should not be empty.
-
RegexStop
The stopping regular expression. Should not be empty.
-
VarName
The name of the variable to contain the substring.
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetSystemEnviron
GetSystemEnviron, get a system environment variable value
Fields: [ ]=
Optional with Default Value
-
string1
String1
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::GetSystemUser
Get the USERID of the currently logged on user as stored in System Environment variables.
DDDriverStringCommands::GetTrimmedField
GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
Fields: [ ]=
Optional with Default Value
-
string1
string1
-
index
0-based index of which field to grab
-
delimiter
delimiter
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Index
Returns the position of the first occurrence of one string
within another string. -1 if not found at all
Fields: [ ]=
Optional with Default Value
-
start
0-based starting offset of the sourceString to search
-
sourceString
sourceString (could come from a ^variable)
-
findString
findString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Left
Returns a string of a specified number of characters copied from the beginning of another string.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
length
number of chars to copy
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::LeftTrim
A new string trimmed of leading tabs and spaces.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Length
Returns the length of a string or variable.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the length
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Replace
Replace 'find' substring with 'replace' substring
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
findString
findString (could come from a ^variable)
-
replaceString
replaceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Right
Returns a string of a specified number of characters copied from the end of another string.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
length
length
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::RightTrim
A new string trimmed of trailing tabs and spaces.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::SubString
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.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
start
starting 0-based offset character position
- [ length = ]
number of chars to copy. If not provided or less than 1 then all characters after the start index will be retrieved.
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::ToLowerCase
Returns a copy of a string, with all letters converted to lowercase.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::ToUpperCase
Returns a copy of a string after converting all letters to uppercase.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]
DDDriverStringCommands::Trim
A new string trimmed of leading and trailing tabs and spaces.
Fields: [ ]=
Optional with Default Value
-
sourceString
sourceString (could come from a ^variable)
-
resultVar
the resultVar to place the result of the
operation into
Examples:
[How To Read This Reference]