Versions Compared

Old Version 37

changes.mady.by.user Menno Gülpers

Saved on

compared with

New Version 38

changes.mady.by.user Menno Gülpers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColorwhite

LENGTH

LENGTH 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
typenote

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 ( ? ) = ?

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

UPPERCASE

UPPERCASE returns a string with all characters in uppercase

Syntax

Code Block
UPPERCASE string
UPPERCASE ( string )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.

Return type

  • string

Example

  • UPPERCASE ( "hello" ) = "HELLO"

  • UPPERCASE "WORLD" = "WORLD"

  • UPPERCASE ( "hello world " ) = "HELLO WORLD "

  • UPPERCASE " hELLo " = " HELLO "

  • UPPERCASE ( ? ) = ?

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

LOWERCASE

LOWERCASE returns 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 ( ? ) = ?

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

CAPITALIZE

CAPITALIZE returns a string with the first character uppercased

Syntax

Code Block
CAPITALIZE string
CAPITALIZE ( string )
CAPITALIZE ( string, lowerTheRest )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.
  • lowerTheRest - An attribute of base type boolean, an expression that results in a boolean or a constant boolean value, indicating that the other characters need to be lowercased. This parameter is optional and if it is not supplied, the other characters are left untouched.

Return type

  • string

Example

  • CAPITALIZE ( "hello" ) = "Hello"

  • CAPITALIZE "WORLD" = "WORLD"

  • CAPITALIZE ( "hello world " ) = "Hello world "

  • CAPITALIZE " hELLo " = " hELLo "

    UI Text Box
    typenote

    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 world " , TRUE ) = "Hello world "

  • CAPITALIZE ( " hELLo " , TRUE ) = " hello "

    UI Text Box
    typenote

    The input string is not trimmed, so in this case the first character is a space.

  • CAPITALIZE( ? ) = ?

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

TRIM

TRIM strips the leading and trailing spaces from a string 

Syntax

Code Block
TRIM string
TRIM ( string )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.

Return type

  • string

Example

  • TRIM "Hello" = "Hello"
  • TRIM ( "Hello World" ) = "Hello World"
  • TRIM "   Hello   World   " = "Hello   World"
  • TRIM ( ? ) = ?

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

INDEXOF

INDEXOF returns the index of the first occurrence of a specified substring in a string

Syntax

Code Block
INDEXOF ( string , substring )
INDEXOF ( string , substring , startIndex )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.
  • substring - 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 search for 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.

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

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

LASTINDEXOF

LASTINDEXOF returns the index of the last occurrence of a specified substring in a string

Syntax

Code Block
LASTINDEXOF ( string , substring )
LASTINDEXOF ( string , substring , startIndex )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.
  • substring - 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 search for the substring should start (inclusive), searching backwards. This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value.

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
  • LASTINDEXOF ( "Hello world" , "o" , 6 ) = 4
  • LASTINDEXOF ( "Hello world" , "a" ) =  -1
  • LASTINDEXOF ( "Hello world" , "o" , 3 ) =  -1

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

SUBSTRING

SUBSTRING returns 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"

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

SUBSTRING BEFORE

SUBSTRING_BEFORE returns 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 )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.
  • substring - An attribute of base type string, an expression that results in a string or a constant string value.

Return type

  • string

Example

  • SUBSTRING BEFORE ":" IN "hello:world" = "hello"
  • SUBSTRING_BEFORE ( "hello:world" , ":" ) = "hello"
  • SUBSTRING_BEFORE ( "hello:world:all" , ":" ) = "hello"
  • SUBSTRING_BEFORE ( "hello:world" , "h" ) = ""
  • SUBSTRING BEFORE "a" IN "hello:world" = ""
  • SUBSTRING_BEFORE ( "" , "hello" ) = ""
  • SUBSTRING_BEFORE ( "hello" , "" ) = ""

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

SUBSTRING AFTER

SUBSTRING_AFTER returns 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 )

  • string - An attribute of base type string, an expression that results in a string or a constant string value.
  • substring - An attribute of base type string, an expression that results in a string or a constant string value.

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"

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

SPLIT

SPLIT returns a multivalued 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 (multivalued)

Example

  • SPLIT "Hello world" ON "o" =  [ "Hell" , " w" , "rld" ]
  • SPLIT ( "Hello world" , "a" ) =  [ "Hello world" ]
  • SPLIT "Hello" ON "o" =  [ "Hell" ]
  • SPLIT ( "ooo" , "o" ) = [ ]
  • SPLIT ( "bot" , "o" )   = [ "b" , "t" ]
  • SPLIT ( "boot" , "o" )  = [ "b" , "", "t" ]
  • SPLIT ( "booot" , "o" ) = [ "b" , "", "t" ]

  • Usage: remove dots from a string in combination with the JOIN function
    JOIN ( SPLIT ( "H.E.L.L.O" , "\.") , "" ) = "HELLO"

    UI Text Box
    typenote

    If you use the SPLIT in a default expression on an multivalued 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 attribute Test.Splitted (multivalued), which has the default expression SPLIT ( "H.E.L.L.O" , "\."). The result of the expression JOIN ( Test.Splitted , "" ) = "HELO" instead of "HELLO" as in the last example.

Include Page
_nav_BackToTop
_nav_BackToTop

Panel
bgColorwhite

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 "

Include Page
_nav_BackToTop
_nav_BackToTop


Panel
bgColorwhite

EQUALS

EQUALS compares two strings and returns TRUE if and only if they are equal. This function is case sensitive.

UI Text Box
typewarning

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
    typenote

    Note that "hello" = "Hello" will return TRUE because it is case insensitive

  • "hello" EQUALS "hello " = FALSE

  • EQUALS ( "" , "" ) = TRUE

Include Page
_nav_BackToTop
_nav_BackToTop