The function byteAt returns the byte on the specified position.

The arg is an input byte array.

The index defines the position in the arg. The first item has index equal to 0.

If the index is out of bound, the function fails.

If any of the arguments is null, the function fails.

Compatibility notice: The function byteAt() has been introduced in CloverETL 4.0.0.

See also:  bitAnd, bitIsSet, bitSet, bitLShift, bitNegate, bitOr, bitRShift, bitSet, bitXor, charAt

The charAt() function returns the character from arg which is located at the given index.

The function works only for indexes between 0 and length of input - 1, otherwise it fails with an error.

For null input and empty string input the function fails with an error.

See also:  byteAt, codePointAt, substring

The chop() function removes the line feed and the carriage return characters or characters corresponding to the provided regular pattern from the string.

For null input the function fails with an error.

If the input is empty string, the function returns empty string.

If the regexp is null, the function fails with an error.

See also:  matches, matchGroups, substring

The function codePointAt() returns code of a Unicode character from the given position in the string str.

The str parameter contains string with Unicode characters. If str is null, the function fails.

The index parameter specifies a position of the character in the string str. The first character has index 0.

If the index parameter is null, the function fails. If the index parameter is out of range of the string (negative or greater than or equal to length of string), the function fails.

See also:  charAt, codePointToChar, isValidCodePoint

The function codePointLength() returns number of char values needed to encode the Unicode character code.

If code is greater than or equal to 0x10000, the function returns 2. Otherwise returns 1. Invalid codes are not checked. If validation is needed, use the isValidCodePoint function.

The parameter code is Unicode code point. If the code is null, the function fails.

See also:  codePointAt, codePointToChar, isValidCodePoint

The function codePointToChar() converts Unicode code to character.

The parameter contains code of the character.

If the code is null, negative or greater than 0x10FFFF, the function fails.

See also:  codePointAt, codePointLength, isUnicodeNormalized

The function concat() returns concatenation of the strings.

The concat function accepts unlimited number of arguments of the string data type. You can also concatenate these arguments using plus signs, but this function is faster for more than two arguments.

Null value of arguments are replaced with string 'null' in concatenated string.

	Note
	Concatenation of more strings with the concat() function is faster than concatenation with + operator.

See also:  concatWithSeparator, cut, substring

The function concatWithSeparator() joins parameters arg1 to argN using separator.

The separator parameter defines a string to be used as a separator in the concatenated string. If the separator parameter is null, the function fails.

The parameters arg1 to argN contain strings to be concatenated. Parameters to be concatenated having null values are omitted.

	Note
	The functions concat() and concatWithSeparator handles null string differently.

See also:  concat, split

The function contains() returns true if the input string contains a substring. Otherwise the function returns false.

If the parameter input is null, the function returns false.

If the parameter substring is null, the function fails.

See also:  endsWith, startsWith, substring

The countChar() returns the number of occurrences of the character specified as the second argument in the string specified as the first argument.

If one of the given arguments is null or an empty string, the function fails with an error.

See also:  length

The cut() function returns a list of strings which are substrings of the original string specified in the first argument.

The second argument (indices) specifies rules on how the first argument is cut. The number of elements of the list specified as the second argument must be even. The integers in the list serve as position (each number in the odd position) and length (each number in the even position). Substrings of the specified length are taken from the string specified as the first argument starting from the specified position (excluding the character at the specified position).

If the first argument is null or an empty string, the function fails with an error.

See also:  matchGroups

The editDistance() function compares two string arguments to each other.

The strength of comparison is 4 by default, the default value of locale for comparison is the system value and the maximum difference is 3 by default.

The function returns the number of letters that should be changed to transform one of the two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

For more details, see another version of the editDistance() function below - the editDistance (string, string, integer, string, integer) function.

If one or both of the input strings to compare are empty strings or null, the function fails with an error.

See also:  metaphone, NYSIIS, soundex

The editDistance() compares two string arguments to each other using the specified locale.

The function accepts two strings that will be compared to each other and the third argument that is the Locale that will be used for comparison. The default strength of comparison is 4. The maximum difference is 3 by default.

The function returns the number of letters that should be changed to transform one of the first two arguments to the other. However, when the function is being executed, if it finds that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

For more details, see another version of the editDistance() function below - the editDistance (string, string, integer, string, integer) function.

If one or both of the input strings to compare are empty strings or null function fails with an error.

The editDistance() compare two string to each other using the specified strength of comparison.

The function accepts two strings that will be compared to each other and the third (integer) that is the strength of comparison. The default locale that will be used for comparison is the system value. The maximum difference is 3 by default.

The function returns the number of letters that should be changed to transform one of the first two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

For more details, see another version of the editDistance() function below - the editDistance (string, string, integer, string, integer) function.

If one or both of the input strings to compare are empty strings or null, the function fails with an error.

The editDistance() function compares two strings to each other using specified strength of comparison and locale.

The function accepts two strings that will be compared to each other, the third argument that is the strength of comparison and the fourth argument that is the Locale that will be used for comparison. The maximum difference is 3 by default.

The function returns the number of letters that should be changed to transform one of the first two arguments to the other. However, when the function is being executed, if it finds that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

For more details, see another version of the editDistance() function below - the editDistance (string, string, integer, string, integer) function.

If one or both of the input strings to compare are empty strings or null, the function fails with an error.

The editDistance() compares two strings to each other using specified locale and maxDifference.

The function accepts two strings that will be compared to each other, the third argument that is the Locale that will be used for comparison and the fourth argument that is the maximum difference. The strength of comparison is 4 by default.

The function returns the number of letters that should be changed to transform one of the first two arguments to the other. However, when the function is being executed, if it finds that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

For more details, see another version of the editDistance() function below - the editDistance (string, string, integer, string, integer) function.

If one or both of the input strings to compare are empty strings or null, the function fails with an error.

The editDistance() compares two strings to each other using specified strength of comparison and maximum difference.

The function accepts two strings that will be compared to each other and two others. These are the strength of comparison (third argument) and the maximum difference (fourth argument). The locale is the default system value.

The function returns the number of letters that should be changed to transform one of the first two arguments to the other. However, when the function is being executed, if it finds that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

For more details, see another version of the editDistance() function below - the editDistance (string, string, integer, string, integer) function.

If one or both of the input strings to compare are empty strings or null, the function fails with an error.

The editDistance() function compares two strings using the specified strength of comparison, locale and maximum difference.

The first two arguments are strings to be compared.

The third argument (integer number) specifies the strength of comparison. It can have any value from 1 to 4.

If it is 4 (identical comparison), it means that only identical letters are considered equal. In case of 3 (tertiary comparison), it means that upper and lower cases are considered equal. If it is 2 (secondary comparison), it means that letters with diacritical marks are considered equal. Lastly, if the strength of comparison is 1 (primary comparison), it means that even the letters with some specific signs are considered equal. In other versions of the editDistance() function where this strength of comparison is not specified, the number 4 is used as the default strength (see above).

The fourth argument is the string data type. It is the Locale that serves for comparison. If no locale is specified in other versions of the editDistance() function, its default value is the system value (see above).

The fifth argument (integer number) means the number of letters that should be changed to transform one of the first two arguments to the other. If another version of the editDistance() function does not specify this maximum difference, the default maximum difference is number 3 (see above).

The function returns the number of letters that should be changed to transform one of the first two arguments to the other. However, when the function is being executed, if it counts that the number of letters that should be changed is at least the number specified as the maximum difference, the execution terminates and the function returns maxDifference + 1 as the return value.

Actually the function is implemented for the following locales: CA, CZ, ES, DA, DE, ET, FI, FR, HR, HU, IS, IT, LT, LV, NL, NO, PL, PT, RO, SK, SL, SQ, SV, TR. These locales have one thing in common: they all contain language-specific characters. A complete list of these characters can be examined in CTL2 Appendix - List of National-specific Characters

If one or both of the input strings to compare are empty strings or null, the function fails with an error.

The function endsWith() checks whether the string str ends with the substr string.

If the parameter str is null, the function returns false.

If the parameter substr is null, the function fails.

See also:  contains, startsWith

The escapeUrl() function escapes illegal characters within components of a specified URL (see isUrl for the URL component description). Illegal characters must be escaped by a percent (%) symbol, followed by the two-digit hexadecimal representation (case-insensitive) of the ISO-Latin code point for the character, e.g., %20 is the escaped encoding for the US-ASCII space character.

The function accepts a valid URL only. For an invalid URL, empty string or null input, the function fails with an error.

See also:  escapeUrlFragment, isUrl, unescapeUrl, unescapeUrlFragment

The escapeUrlFragment function escapes potentially obtrusive characters.

The input parameter is a string to be escaped. If the input is null, the null is returned.

The optional parameter encoding enables to change encoding of the result string. The default encoding is UTF-8. If the encoding is null function fails.

See also:  escapeUrl, isUrl, unescapeUrl, unescapeUrlFragment

The find() function returns a list of substrings corresponding to the regular expression pattern that is found in the second argument.

If the second argument is an empty string, the function returns a list of empty strings. The sum of empty strings in the list is same as the length of the original string plus one; e.g. the string 'mark' results in the list of five empty strings.

If one or both of the two arguments are null value, the function fails with an error.

The third argument specifies which regular expression group to use.

See also:  matchGroups

The getAlphanumericChars() function returns only letters and digits contained in a given argument in the order of their appearance in the string. The other characters are removed.

For an empty string input, the function returns an empty string. For null input, the function returns null.

If the takeAlpha is present and set to true and takeNumeric is set to false, the function will return letters only.

If the takeNumeric is present and set to true and takeAlpha is set to false, the function will return numbers only.

See also:  removeBlankSpace, removeDiacritic, removeNonAscii

The function getComponentProperty() returns value of a component attribute.

The propertyName argument is a name of an attribute of a component.

If propertyName is null, the function getComponentProperty() returns null.

If propertyName does not match a name of any existing attribute, the function returns null.

	COMPATIBILITY NOTICE
	The function getComponentProperty() is available since CloverETL version 4.0.

See also:  toProjectUrl

The getFileExtension() function extracts a file extension from a specified path or URL.

Returns the textual part of the file name after the last dot. There must be no directory separator after the dot. If extension is not present in the argument, returns an empty string.

The function returns null value for null input.

See also:  getFileName, getFileNameWithoutExtension, getFilePath, normalizePath,

The getFileName() function extracts a file name from a specified path or URL.

Returns the text after the last forward or backslash. If the file name is not present in the argument, returns an empty string.

The function returns null value for null input.

See also:  getFileExtension, getFileNameWithoutExtension, getFilePath, normalizePath,

The getFileNameWithoutExtension() function extracts a base file name from a specified path or URL.

Returns the text after the last forward or backslash and before the last dot. If the base name is not present in the argument, returns an empty string.

The function returns null value for null input.

See also:  getFileExtension, getFileName, getFilePath, normalizePath,

The getFilePath() function extracts a file path (without the file name) from a specified full path or URL.

Returns the text before and including the last forward or backslash. Also replaces backslashes with forward slashes. If the path is not present in the argument, returns an empty string.

The function returns null value for null input.

See also:  getFileExtension, getFileName, getFileNameWithoutExtension, normalizePath,

The getUrlHost() function parses out a host name from a specified URL.

If the hostname part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. See isUrl for the scheme.

The function returns null value for an empty string and null input.

See also:  getUrlPath, getUrlPort, getUrlProtocol, getUrlQuery, getUrlUserInfo, getUrlRef, isUrl

The getUrlPath() function parses out a path from a specified URL.

If the path part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. See isUrl for the scheme.

The function returns null value for an empty string and null input.

See also:  getUrlHost, getUrlPort, getUrlProtocol, getUrlQuery, getUrlUserInfo, getUrlRef, isUrl

The getUrlPort() function parses out a port number from a specified URL

If the port part is not present in the URL argument, -1 is returned. If the URL has invalid syntax, -2 is returned. See isUrl for the scheme.

The function returns -2 value for an empty string and null input.

See also:  getUrlHost, getUrlPath, getUrlProtocol, getUrlQuery, getUrlUserInfo, getUrlRef, isUrl

The getUrlProtocol() function parses out a protocol name from a specified URL.

If the protocol part is not present in the URL argument, an empty string is returned. If the URL is not valid, null is returned. See isUrl for the scheme.

The function returns null value for the empty string and null input.

See also:  getUrlHost, getUrlPath, getUrlPort, getUrlQuery, getUrlUserInfo, getUrlRef, isUrl

The getUrlQuery() function parses out a query (parameters) from a specified URL.

If the query part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. See isUrl for the scheme.

The function returns null value for the empty string and null input.

See also:  getUrlHost, getUrlPath, getUrlPort, getUrlProtocol, getUrlUserInfo, getUrlRef, isUrl

The getUrlRef() function parses out the fragment after # character, also known as ref, reference or anchor, from a specified URL.

If the fragment part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. See isUrl for the URL scheme.

The function returns null value for the empty string and null input.

See also:  getUrlHost, getUrlPath, getUrlPort, getUrlProtocol, getUrlQuery, getUrlUserInfo, isUrl

The getUrlUserInfo() function parses out a username and password from a specified URL.

If the userinfo part is not present in the URL argument, an empty string is returned. If the URL syntax is invalid, null is returned. See isUrl for the scheme.

The function returns null value for the empty string and null input.

See also:  getUrlHost, getUrlPath, getUrlPort, getUrlProtocol, getUrlQuery, getUrlRef, isUrl

The indexOf() function returns the index (zero-based) of the first occurrence of substring in the string. Returns -1 if no occurrence is found.

If the parameter arg is null, the function returns -1. See compatibility notice.

If the second argument is null, the function fails with an error. If the second argument is an empty string, the function returns 0.

Start position for search is set up using parameter fromIndex.

	Compatibility Notice
	In CloverETL 3.5.x and earlier the function fails with an error if the arg argument is null. For example indexOf(null, "chair") in CloverETL 3.5.x and earlier fails.

See also:  indexOf, matches

The isAscii() checks the string for occurrence of non-ascii characters.

The function takes one string argument and returns a boolean value depending on whether the string can be encoded as an ASCII string (true) or not (false).

If the input is null or empty string, the function returns true.

See also:  isBlank, isDate, isInteger, isLong, isNumber, removeDiacritic, removeNonAscii, removeNonPrintable

The isBlank() function takes one string argument and returns a boolean value depending on whether the string contains only white space characters (true) or not (false).

If the input is null or an empty string, the function returns true.

See also:  removeBlankSpace

The isDate() function returns true if the input matches the date pattern. Returns false otherwise.

If the input is null, the function returns false.

If the pattern is null or an empty string, the default date format is used.

If the parameter locale is missing, default Locale is used.

If the parameter timeZone is missing, default Time Zone is used.

If strict is true, the date format is checked using a conversion from string to date, conversion from date to string and subsequent comparison of the input string and result string. If the input string and result string differ, the function returns false. This way you can enforce a required number of digits in the date.

If strict is null or the function does not have the argument strict, it works the same way as if set to false - the format is not checked in the strict way.

Compatibility notice: The functions isDate(string, string, boolean), isDate(string, string, string, boolean) and isDate(string, string, string, string, boolean) are available since CloverETL 4.1.0.

See also:  isInteger, isLong, isNumber, str2date

The isDecimal function checks a possibility to convert a string to a decimal data type.

The parameter arg is the string to be checked. If the parameter arg can be converted to decimal, the function returns true, otherwise it returns false. It the parameter is null, the function returns false.

See also:  isDate, isInteger, isLong, isNumber

The isEmpty() function checks whether a given string is null or of zero length.

If arg is null, function returns true.

See also:  Container functions: isEmpty

The isInteger() function checks a possibility to convert a string to an integer.

The function takes one string argument and returns a boolean value depending on whether the string can be converted to an integer number (true) or not (false).

If the input is an empty string or null, the function returns false.

See also:  isDate, isDecimal, isLong, isNumber

The isLong() function checks a possibility to convert a string to a long number.

The function takes one string argument and returns a boolean value depending on whether the string can be converted to a long number (true) or not (false).

If the input is an empty string or null, the function returns false.

See also:  isDate, isDecimal, isInteger, isNumber

The isNumber() function checks a possibility to convert a string to a number (double).

The function takes one string argument and returns a boolean value depending on whether the string can be converted to a double (true) or not (false).

If the input is an empty string or null, the function returns false.

See also:  isDate, isDecimal, isInteger, isLong

Determine whether the str input string is Unicode normalized according to the given form.

The parameter str is a string to be checked for accordance with the normalized form. If the parameter str is null, the function returns true.

The parameter form contains identification of the Unicode normalization form. Following normalization forms are available:

If the parameter form is null, the function fails.

See also:  codePointToChar, isValidCodePoint, unicodeNormalize

The isUrl() function checks whether a specified string is a valid URL of the following syntax

            
foo://username:[email protected]:8042/there/index.dtb?type=animal;name=cat#nose
\_/   \____________/ \______/ \__/\______________/ \__________________/ \__/
 |           |          |      |         |                  |             |
protocol  userinfo     host   port      path               query         ref

See http://www.ietf.org/rfc/rfc2396.txt for more info about the URI standards.

If the input is empty string or null, the function returns false.

See also:  escapeUrl, getUrlHost, getUrlPath, getUrlPort, getUrlProtocol, getUrlQuery, getUrlUserInfo, getUrlRef, unescapeUrl

The function isValidCodePoint() returns true if the code value is valid Unicode code point.

If the parameter code is null, the function returns false.

See also:  codePointAt, codePointLength, codePointToChar

The join() coverts elements from the list or map of elements to their string representation and puts them together with the first argument as a delimiter.

If the delimiter is null, the function joins string representations of elements from the list with the empty string.

See also:  concat

The function lastIndexOf returns an index of the last occurrence of the substr substring within the given string input, searching backwards from the given position or from the end.

The parameter input is a string in which the occurrence of the substr string is searched. If input is null, the function returns -1.

The parameter substr is a substring to be searched. If the parameter substr is null, the function fails.

The parameter index denotes the position in the input, where the substring matching process starts. If the parameter is negative, the function returns -1. If the parameter is null, the function fails.

See also:  indexOf

The left() function returns a substring of input with the specified length.

If the input is shorter than length, the function returns the input unmodified. The result may be padded with spaces, based on the value of spacePad.

If the input is null, the function returns null.

If spacePad is set to false, the function behaves the same way as the left(string, integer) function. If spacePad is set to true and the input is shorter than length, the function pads the input with blank spaces from the right side.

See also:  right, substring

The length() function accepts a structured data type as its argument: string, <element type>[], map[<type of key>,<type of value>] or record. It takes the argument and returns a number of elements forming the structured data type.

If the argument is null or empty string, the function returns 0.

See also:  Container functions: length, Record functions: length

The lowerCase() function returns the input string with letters converted to lower case only.

If the input is null, the function returns null.

See also:  upperCase

The lpad() function pads input string from left using specified characters.

If the parameter input is null the function returns null.

The parameter length is minimal length of an output string. If the string length is lower than the parameter length, the string is padded from left using space or using filler. Otherwise the input string is returned.

If the parameter length is negative or null, the function fails.

It the filler parameter is null, empty string or longer than one character, function fails.

See also:  left, right, rpad

The matches() function checks the string to match the provided regular pattern.

The function returns true, if the text matches the regular expression regex. Otherwise it returns false.

If the text is null, the function returns false. If the regex is null, the function fails with an error.

See also:  isAscii, isBlank, isDate, isDecimal, isInteger, isLong, isNumber, isUrl

The matchGroups() function returns the list of group matches (the substrings matched by the capturing groups of the regex), if text matches the regular expression regex.

The list is zero-based and the element with index 0 is the match for the entire expression. The following elements (1, ...) correspond with the capturing groups indexed from left to right, starting at one. The returned list is unmodifiable. If text does not match regex, null is returned.

If the text argument is null, the function returns null. If the regex is null, the function fails with an error.

See also:  cut, split, substring

The metaphone() function returns the metaphone code of the first argument.

For more information, see the following site: www.lanw.com/java/phonetic/default.htm.

The default maximum length of the metaphone code is 4.

The function returns null value for the null input.

See also:  editDistance, NYSIIS, soundex

The normalizePath() function normalizes a specified path or URL to a standard format, removing single and double dot path segments. Also replaces backslashes with forward slashes.

If normalization fails because there is a double dot path segment that is not preceded by a removable parent path segment, the function returns null.

The function returns a null value for a null input.

See also:  getFileExtension, getFileName, getFileNameWithoutExtension, getFilePath,

The NYSIIS() function returns the New York State Identification and Intelligence System Phonetic Code of the argument.

For more information, see the following site: http://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System. This implementation works with numbers. Input string which contains numbers will result in unchanged string. E.g. input '1234' results in string '1234'.

If the input of function is null, the function returns null. If the input of function is empty string, the function returns empty string.

See also:  editDistance, metaphone, soundex

The randomString() function returns a string consisting of lowercase letters.

Its length is between <minLength; maxLength>. Characters in the generated string always belong to ['a'-'z'] (no special symbols).

If one of the given arguments is null, the function fails with an error.

See also:  random, randomBoolean, randomDate, randomGaussian, randomInteger, randomUUID, setRandomSeed

The function randomUUID() generates a random universally unique identifier (UUID).

The generated string has this format:

hhhhhhhh-hhhh-hhhh-hhhh-hhhhhhhhhhhh

where h belongs to [0-9a-f]. In other words, you generate hexadecimal code of a random 128bit number.

For more details on the algorithm used, see the Java documentation.

See also:  random, randomBoolean, randomDate, randomGaussian, randomInteger, randomString, setRandomSeed

The removeBlankSpace() function takes one string argument and returns another string with white characters removed.

The function removes chars 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x1C, 0x1D, 0x1E and 0x1F. The function does not remove chars 0x00A0 (hard space), 0x2007 and 0x202F.

If the input is null, the function returns null.

See also:  isBlank, removeDiacritic, removeNonAscii, removeNonPrintable, trim

The removeDiacritic() function takes one string argument and returns another string with diacritical marks removed.

If the input is null, the function returns null.

See also:  isAscii, removeBlankSpace, removeNonAscii, removeNonPrintable

The removeNonAscii() function returns string with non-ascii characters removed.

If the input is null, the function returns null.

See also:  isAscii removeBlankSpace, removeNonAscii, removeNonPrintable

The removeNonPrintable() function takes one string argument and returns another string with non-printable characters removed.

If the input is null, the function returns null.

Note that since version 3.5, the function does not remove non-ASCII characters anymore. If you need to have them removed, please use the removeNonAscii(string) function in addition.

See also:  isAscii, removeBlankSpace, removeDiacritic, removeNonAscii

The replace() function replaces characters from the input string matching the regexp with the specified replacement string.

The function takes three string arguments - a string, a regular expression, and a replacement.

All parts of the string that match the regex are replaced. The user can also reference the matched text using a backreference in the replacement string. A backreference to the entire match is indicated as $0. If there are capturing parentheses, specifics groups as $1, $2, $3, etc. can be referenced.

Important - please beware of similar syntax of $0, $1 etc. While used inside the replacement string it refers to matching regular expression parenthesis (in order). If used outside a string, it means a reference to an input field. See the examples.

A modifier can be used at the start of the regular expression: (?i) for case-insensitive search, (?m) for multiline mode or (?s) for "dotall" mode where a dot (".") matches even a newline character

If the first argument of the function is null, the function returns null. If the regexp pattern is null, the function fails with an error. If the third argument is null, the function fails with an error, unless the specified regexp does not match the first input.

See also:  lowerCase translate upperCase

The reverse() function reverses the order of characters of a given string and returns the reverted string.

If the given string is null, the function returns null.

See also:  Record functions: reverse

The right() function returns the substring of the length specified as the second argument counted from the end of the string specified as the first argument.

If the input string is shorter than the length parameter, the function returns the original string.

If the input is null, the function returns null.

If the spacePad argument is set to true, the new string is padded. Whereas if it is false or the function does not have the argument spacePad, the input string is returned as the result with no space added.

See also:  left, substring

The function rpad pads a string from right side to specified length using space or user-defined character.

The parameter input contains a string to be padded. If the input is shorter than specified in the parameter length, the input is padded from the right side using filler. The input with sufficient length is returned unmodified.

If the parameter input is null, function returns null.

The parameter length defines the minimal length of the result string. If the parameter length is negative, the function fails.

Optional parameter filler defines the character used for pad. Function rpad(string, integer) uses space character as a filler. If the filler is null, empty string or a string having more than 1 character, the function fails.

See also:  left, lpad, right

The soundex() function takes one string argument and converts the string to another.

The resulting string consists of the first letter of the string specified as the argument and three digits. The three digits are based on the consonants contained in the string when similar numbers correspond to similarly sounding consonants.

If the input of the function is null, the function returns null.

If the input is an empty string, the function returns an empty string.

See also:  editDistance, metaphone, NYSIIS

The split() function splits a string from the first argument, based on a regular expression given as the second argument.

The function searches in the first argument for substrings matching the regexp. If any substring matching the regexp exists, it is used as a delimiter and the arg is split up using the delimiter. The resulting parts of the string are returned as a list of strings. If the regular pattern does not match any character in the string arg, a list containing one item (the string arg) is returned.

The function split() removes terminating empty list items from the result. See the function split("cuckoo","o") in examples.

If the input parameter arg is an empty string, the function returns a list with one empty string.

If the input arg is null, the function returns an empty list.

If the regexp argument is null, the function fails with an error.

Parameter limit limits the number of items in the list to be returned. If the limit is positive, at most the specified number of items will be returned. The unsplitted residuum of input string is the last item of the list. If the limit is zero, the limit is not applied and the function works as without the limit parameter: The trailing empty list items are trimmed. If the limit parameter is negative, the limit is not applied and trailing empty fields are not trimmed. If the function is called without the limit parameter, it works in the same way as with limit set to 0.

	Compatibility Notice
	If the input (arg) of the function is null, the function returns a list with one null string in CloverETL 3.5.x and earlier.

See also:  concat, concatWithSeparator, substring, matchGroups

The startsWith() function returns true if the parameter str starts with string sub.

If the parameter str is null, the function returns false.

If the parameter sub is null, the function fails.

See also:  contains, endsWith

The substring() function returns a substring of an input string.

The function substring(arg, fromIndex) returns a substring of arg starting at the position fromIndex.

The function substring(arg, fromIndex, length) returns a substring of arg starting at the position fromIndex limited by length.

If the original string arg is null, the function returns null. If the arg is empty string, the function returns empty string. See the compatibility notice.

The parameter fromIndex defines the starting position of the substring. If fromIndex is negative or null, the function fails. See compatibility notice.

The parameter length is a maximal length of the returned substring. If length is negative or null, the function fails.

Compatibility notice:

The function substring() works differently in CloverETL 3.5.x and earlier. The function substring() fails, if the input string arg is null in version 3.5.x and earlier. The function substring() fails, if any of integer parameters is null or out of range of the input string in version 3.5.x. Since version 4.0.0.M1, it fails only with negative or null values. The function substring(string, integer) is available since CloverETL 4.0.0-M1

See also:  charAt, cut, left, right, trim

The toProjectUrl() function converts a relative path like data-in/file.txt to a full URL containing the name of sandbox: sandbox://mysandbox/data-in/file.txt.

The parameter path is a relative path to the file.

If the parameter path is null, the function toProjectUrl() returns null.

	COMPATIBILITY NOTICE
	The function toProjectUrl() has been introduced in CloverETL 4.0.

The translate() function replaces the characters given in the second string of the first argument with characters from the third string.

If one or both of the second or the third argument is null, the function fails with an error.

If the input of the function is null, the function returns null.

See also:  replace

The trim() function takes one string argument and returns another string with leading and trailing white spaces removed.

If the input of the function is an empty string, the function returns an empty string.

If the input of the function is null, the function returns null.

See also:  isBlank removeBlankSpace, replace, substring

The unescapeUrl() function decodes escape sequences of illegal characters within components of a specified URL.

Escape sequences consist of a percent (%) symbol, followed by the two-digit hexadecimal representation (case-insensitive) of the ISO-Latin code point for the character, e.g., %20 is the escaped encoding for the US-ASCII space character. See isUrl for the URL component description.

Function accepts a valid URL only. For an invalid URL, empty string or null input, the function fails with an error.

See also:  escapeUrl, escapeUrlFragment, isUrl, unescapeUrlFragment

The function unescapes a string escaped by escapeUrlFragment.

The parameter input is a string to be unescaped. It the parameter is null, the function returns null.

The parameter encoding is an encoding to be used in conversion. If the encoding is null, the conversion fails.

See also:  escapeUrl, escapeUrlFragment, isUrl, unescapeUrl

The unicodeNormalize() normalizes an input string using a specified normalization form.

The parameter input contains the string to be normalized. If the parameter input is null, the function returns null.

The parameter form defines the normalization form to be used. Following normalization forms are available:

If the parameter form is null, the function fails.

See also:  isUnicodeNormalized

The upperCase() function takes one string argument and returns another string with cases converted to upper cases only.

The function returns null for a null input.

See also:  lowerCase