Page History
Learn more about text functions CONCATENATE, JOIN, MATCH, FIND, FIRST, LAST, LENGTH, UPPERCASE, LOWERCASE, CAPITALIZE, TRIM, INDEXOF, LASTINDEXOF, SUBSTRING, SUBSTRING BEFORE, SUBSTRING AFTER, SPLIT, REPLACE, EQUALS.
Overview
Table of Contents | ||
---|---|---|
|
...
bgColor | white |
---|
Function | Description |
---|
CONCATENATE | Use the '+ ' (plus) operator to concatenate strings or a combination of strings and other type values to produce a single string value |
...
Syntax
Code Block |
---|
string1 + string2 + ... + value1 + ... |
- string1 - The first string that you want to concatenate.
- string2 - The second string that you want to concatenate.
- value1 - A value of some type of number, date or boolean that you want to add to the new string value.
Return type
- string
Examples
...
. |
...
...
UI Text Box | ||
---|---|---|
| ||
There exists a |
Joins |
...
bgColor | white |
---|
JOIN
...
a series of values into one string, separated with a character of your choice. |
...
Syntax
Code Block |
---|
JOIN ( argument1 , argument2 , ... , separator ) |
- argument1, argument2 - Attributes or expressions that contain the values that will be joint to a single string. JOIN works for all base types, even multivalued.
- separator - A string value that will be used as separator symbol.
Return type
- string
UI Text Box | ||
---|---|---|
| ||
an UNKNOWN value will be represented as an empty entry in the result string. |
UI Text Box | ||
---|---|---|
| ||
The |
Examples
Suppose you have a model containing the following attributes.
...
JOIN ( Person.name , Person.date_of_birth , ";" ) = "John;Sun Jan 01 00:00:00 CET 1995"
JOIN ( Person.name , Person.name , "@" ) = "John@John"
JOIN ( Person.name , Person.family_name , YEARS BETWEEN Person.date_of_birth AND DATE ( 2015 , 01 , 01 ) , ";" ) = "John;;20"
...
bgColor | white |
---|
MATCH
...
MATCH | Compares |
...
a string pattern to another string and returns TRUE if the string exactly matches the pattern, and otherwise FALSE. The MATCH function is case-sensitive |
...
Syntax
Code Block |
---|
MATCH ( pattern , string ) |
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
- string - String value, attribute of base type string or an expression that results in a string value.
Return type
- boolean
Examples
If the attribute File.name
is of base type string and its value is "Thisfile_1.doc" then
...
MATCH ( "Thisfile_1.doc" , File.name ) = TRUE
...
MATCH ( File.name , "Thisfile_1.doc" ) = TRUE
...
. |
...
...
MATCH ( "thisfile_1.doc" , File.name ) = FALSE
...
MATCH ( "[a-z]hisfile_1.doc" , File.name ) = FALSE
...
MATCH ( ".............." , File.name ) = TRUE
...
FIND | Looks |
...
bgColor | white |
---|
FIND
...
for a string pattern within another string and returns the first matching characters. The function is case-sensitive. |
...
Syntax
Code Block |
---|
FIND ( pattern , string )
FIND ( pattern , string , startIndex ) |
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
- string - An attribute of base type string or an expression that results in a string.
- startIndex - A positive integer value indicating at which character of the string the search should start (inclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. The first character starts at index 0.
Return type
- string
Examples
If File.name
is an attribute of base type string with value "Thisfile_1.doc", then:
...
FIND ( "_[1-5]" , File.name ) = "_1"
...
FIND ( "File" , File.name ) = UNKNOWN
...
...
FIND ( "el" , "Hello" , 2 ) = UNKNOWN
...
FIND ( "eo" , "Hello" ) = UNKNOWN
...
FIND ( "\s[a-zA-Z]+" , "Hello world example" ) = "world"
...
FIND ( "\s[a-zA-Z]+" , "Hello world example" , 6 ) = "example"
FIRST | Returns |
...
bgColor | white |
---|
FIRST
...
the first character(s) of a string, based on the number of characters you specify |
...
Syntax
Code Block |
---|
FIRST integer CHARACTERS OF string
FIRST CHARACTER OF string |
...
. |
...
...
Return type
- string
UI Text Box | ||
---|---|---|
| ||
If you prefer a functional syntax, you can use the STR_FRONT( string, integer ) function. Example: STR_FRONT("Blueriq", 3) = "Blu" |
Examples
If File.name
is an attribute of base type string with value "Thisfile_1.doc" and the integer attribute File.prefix
has value 8 then:
FIRST File.prefix CHARACTERS OF File.name = "Thisfile"
FIRST CHARACTER OF File.name = "T"
FIRST 5 CHARACTERS OF "pieceofcake" = "piece"
...
bgColor | white |
---|
LAST | Returns |
LAST
...
the last character(s) of a string, based on the number of characters you specify. |
...
Syntax
Code Block |
---|
LAST integer CHARACTERS OF string
LAST CHARACTER OF string |
- integer - A positive integer value. This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. LAST CHARACTER OF can be used to retrieve only the last character of the string.
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- string
UI Text Box | ||
---|---|---|
| ||
If you prefer a functional syntax, you can use the STR_BACK ( string, integer ) function. Example: STR_BACK("Blueriq", 3) = "riq" |
Examples
If File.name
is an attribute of base type string with value "Thisfile_1.doc" and the integer attribute File.extension
has value 3 then:
LAST File.extension CHARACTERS OF File.name = "doc"
LAST CHARACTER OF File.name = "c"
LAST 4 CHARACTERS OF "pieceofcake" = "cake"
...
...
bgColor | white |
---|
...
Returns the length of a string |
...
Syntax
Code Block |
---|
LENGTH ( string ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- integer
UI Text Box | ||
---|---|---|
| ||
Spaces at the start of the end of the string are counted as well, the string is not trimmed. |
Example
LENGTH ( "Blueriq" ) = 7
LENGTH ( " Blueriq " ) = 9
LENGTH ( ? ) = ?
...
bgColor | white |
---|
UPPERCASE
. | |
UPPERCASE | Returns |
...
a string with all characters in uppercase |
...
Syntax
Code Block |
---|
UPPERCASE string
UPPERCASE ( string ) |
...
. |
...
Return type
- string
Example
...
UPPERCASE ( "hello" ) = "HELLO"
...
...
...
UPPERCASE ( "hello world " ) = "HELLO WORLD "
...
UPPERCASE " hELLo " = " HELLO "
...
LOWERCASE | Returns |
...
bgColor | white |
---|
LOWERCASE
...
a string with all characters in lowercase |
...
Syntax
Code Block |
---|
LOWERCASE string
LOWERCASE ( string ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- string
Example
LOWERCASE ( "hello" ) = "hello"
LOWERCASE "WORLD" = "world"
LOWERCASE ( "Hello World " ) = "hello world "
LOWERCASE " hELLo " = " hello "
LOWERCASE ( ? ) = ?
. | |
CAPITALIZE | Returns |
...
bgColor | white |
---|
CAPITALIZE
...
a string with the first character uppercased |
...
Syntax
Code Block |
---|
CAPITALIZE string
CAPITALIZE ( string )
CAPITALIZE ( string, lowerTheRest ) |
...
. |
...
Return type
- string
Example
...
CAPITALIZE ( "hello" ) = "Hello"
...
CAPITALIZE "WORLD" = "WORLD"
...
CAPITALIZE ( "hello world " ) = "Hello world "
...
CAPITALIZE " hELLo " = " hELLo "
UI Text Box | ||
---|---|---|
| ||
The input string is not trimmed, so in this case the first character is a space. |
...
CAPITALIZE ( "hello" , TRUE ) = "Hello"
...
CAPITALIZE ( "WORLD" , TRUE ) = "World"
...
...
...
CAPITALIZE ( " hELLo " , TRUE ) = " hello "
UI Text Box | ||
---|---|---|
| ||
The input string is not trimmed, so in this case the first character is a space. |
...
TRIM | Strips |
...
bgColor | white |
---|
TRIM
...
the leading and trailing spaces from a |
...
Syntax
...
string |
...
. |
...
Return type
- string
Example
...
TRIM "Hello" = "Hello"
...
...
...
bgColor | white |
---|
...
Returns the index of the first occurrence of a specified substring in a string |
...
Syntax
Code Block |
---|
INDEXOF ( string , substring )
INDEXOF ( string , substring , startIndex ) |
...
. |
...
LASTINDEXOF | Returns |
Return type
- integer - the index of the first occurrence of the specified substring or -1 if it is not found
Example
INDEXOF ( "Hello world" , "o" ) = 4
INDEXOF ( "Hello world" , "o" , 5 ) = 7
INDEXOF ( "Hello world" , "a" ) = -1
INDEXOF ( "Hello world" , "o" , 8 ) = -1
...
bgColor | white |
---|
LASTINDEXOF
...
the index of the last occurrence of a specified substring in a string |
...
Syntax
Code Block |
---|
LASTINDEXOF ( string , substring )
LASTINDEXOF ( string , substring , startIndex ) |
...
...
. |
...
Return type
- integer - the index of the last occurrence of the specified substring or -1 if it is not found
Example
...
LASTINDEXOF ( "Hello world" , "o" ) = 7
...
...
...
bgColor | white |
---|
SUBSTRING | Returns |
SUBSTRING
...
the substring of a given string starting from the index provided and ending at the end index if provided, or the end of the string |
...
Syntax
Code Block |
---|
SUBSTRING ( string , startIndex )
SUBSTRING ( string , startIndex , endIndex ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
- startIndex - A positive integer value indicating at which character the substring should start (inclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. The first character starts at index 0.
- endIndex - A positive integer value indicating at which character the substring should end (exclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. The
endIndex
cannot exceed the length of the string and should be larger than the startIndex.
Return type
- string
Example
SUBSTRING ( "Hello world" , 1 ) = "ello world"
SUBSTRING ( "Hello world" , 0 , 1 ) = "H"
SUBSTRING ( "Hello world" , 1 , 5 ) = "ello"
SUBSTRING ( "Hello world" , 0 ) = "Hello world"
SUBSTRING ( "Hello world" , 0 , LENGTH( "Hello world" ) ) = "Hello world"
. | |
SUBSTRING BEFORE | Returns |
...
bgColor | white |
---|
SUBSTRING BEFORE
...
the start of a given string before the first occurrence of substring, or an empty string if substring is not found |
...
Syntax
Code Block |
---|
SUBSTRING BEFORE substring IN string
SUBSTRING_BEFORE ( string , substring ) |
...
. |
...
...
Return type
- string
Example
...
SUBSTRING_BEFORE ( "hello:world" , ":" ) = "hello"
...
AFTER | Returns |
...
bgColor | white |
---|
SUBSTRING AFTER
...
the end of a given string after the first occurrence of substring, or an empty string if substring is not found |
...
Syntax
Code Block |
---|
SUBSTRING AFTER substring IN string
SUBSTRING_AFTER ( string , substring ) |
...
. |
...
...
Return type
- string
Example
SUBSTRING AFTER ":" IN "hello:world" = "world"
SUBSTRING_AFTER ( "hello:world:all
" , ":" ) = "world:all"
SUBSTRING AFTER "a" IN "hello:world" = ""
SUBSTRING_AFTER ( "" , "hello" ) = ""
SUBSTRING_AFTER ( "hello" , "" ) = "hello"
...
...
bgColor | white |
---|
...
Returns a |
...
multivalued string attribute containing every substring that is delimited by the given pattern. |
Syntax
Code Block |
---|
SPLIT string ON pattern
SPLIT ( string , pattern ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
Return type
- string (multivalue)
Example
SPLIT "Hello world" ON "o" = [ "Hell" , " w" , "rld" ]
SPLIT ( "Hello world" , "a" ) = [ "Hello world" ]
SPLIT "Hello" ON "o" = [ "Hell" ]
SPLIT ( "ooo" , "o" ) = [ ]
Usage: remove dots from a string in combination with the JOIN function
JOIN ( SPLIT ( "H.E.L.L.O" , "\.") , "" ) = "HELLO"
UI Text Box type note If you use the
SPLIT
in a default expression on an multivalue attribute, please note that the result will be stored as collection, meaning that all duplicates will be removed. To illustrate this: suppose we have an attributeTest.Splitted
(multivalue), which has the default expressionSPLIT ( "H.E.L.L.O" , "\.")
. The result of the expression JOIN ( Test.Splitted , "" ) = "HELO" instead of "HELLO" as in the last example.
...
bgColor | white |
---|
REPLACE
The REPLACE
function replaces every occurrence of a string pattern within another string with a provided replacement string The function is case-sensitive.
Syntax
Code Block |
---|
REPLACE pattern IN string WITH replacement
REPLACE ( pattern , string , replacement ) |
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
- string - An attribute of base type string or an expression that results in a string.
- replacement - An attribute of base type string or an expression that results in a string.
Return type
- string. If the pattern is not found, the original string is returned.
Examples
REPLACE ":" IN "hello:world:example" WITH " " = "hello world example"
REPLACE ( "o" , "hello world" , "a" ) = "hella warld"
REPLACE ( "O" , "hello world" , "a" ) = "hello world"
REPLACE "\s" IN "hello world example" WITH "" = "helloworldexample"
REPLACE ( "\d{2}" , "hello1 world22 example333" , "@" ) = "hello1 world@ example@3"
REPLACE ( "" , "hello world" , " " ) = " h e l l o w o r l d "
REPLACE | Replaces every occurrence of a string pattern within another string with a provided replacement string. The function is case-sensitive. |
EQUALS | Compares two strings and returns TRUE if and only if they are equal. This function is case sensitive. |
Go here for more info on the Text Substitution Language (TSL) documentation.
Functions
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
...
bgColor | white |
---|
EQUALS
EQUALS
compares two strings and returns TRUE if and only if they are equal. This function is case sensitive.
UI Text Box | ||
---|---|---|
| ||
Only use this function if you need a case sensitive comparison of two strings. If you want to compare strings case insensitive, use the '=' operator instead. |
Syntax
Code Block |
---|
string1 EQUALS string2
EQUALS ( string1 , string2 ) |
- string1 - An attribute of base type string, an expression that results in a string or a constant string value.
- string2 - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- boolean
Example
"hello" EQUALS "hello" = TRUE
EQUALS ( "hello" , "Hello" ) = FALSE
UI Text Box type note Note that "hello" = "Hello" will return TRUE because it is case insensitive
"hello" EQUALS "hello " = FALSE
EQUALS ( "" , "" ) = TRUE
...