You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

UPPERCASE


UPPERCASE returns a string with all characters in uppercase. 


Syntax

UPPERCASE string



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

UPPERCASE does not have a functional syntax. This can have unexpected effects on concatenation. UPPERCASE ( "hello" ) + LOWERCASE ( " WORLD" ) is equivalent to UPPERCASE ( ( "hello" ) + LOWERCASE ( " WORLD" ) ). Use ( UPPERCASE string ) syntax to avoid this behaviour.


Return type

  • string


Example

ExpressionResultType
UPPERCASE ( "hello" )"HELLO"String
UPPERCASE "WORLD""WORLD"String
UPPERCASE ( "hello world " )"HELLO WORLD "String
UPPERCASE " hELLo "" HELLO "String
UPPERCASE ( ? )?String
( UPPERCASE "hello" ) + ( LOWERCASE " WORLD" )"HELLO world"String
UPPERCASE ( "hello" ) + LOWERCASE ( " WORLD" )"HELLO WORLD"String


Back to Top

LOWERCASE


LOWERCASE returns a string with all characters in lowercase. 


Syntax

LOWERCASE string



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

LOWERCASE does not have a functional syntax. This can have unexpected effects on concatenation. LOWERCASE ( "HELLO" ) + UPPERCASE ( " world" ) is equivalent to LOWERCASE ( ( "HELLO" ) + UPPERCASE ( " world" ) ). Use ( LOWERCASE string ) syntax to avoid this behaviour.


Return type

  • string


Example

ExpressionResultType
LOWERCASE ( "hello" )"hello"String
LOWERCASE "WORLD""world"String
LOWERCASE ( "hello world " )"hello world "String
LOWERCASE " hELLo "" hello "String
LOWERCASE ( ? )?String
( LOWERCASE "HELLO" ) + ( UPPERCASE " world" )"hello WORLD"String
LOWERCASE ( "HELLO" ) + UPPERCASE ( " world" )"hello world"String


Back to Top

CAPITALIZE


CAPITALIZE returns a string with the first character uppercased. 


Syntax

CAPITALIZE string
CAPITALIZE ( string, lowerTheRest )


Inputs

  • 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

ExpressionResultType
CAPITALIZE "hello""Hello"String
CAPITALIZE ( "WORLD" )"WORLD"String
CAPITALIZE ( "hello world " )"Hello world "String
CAPITALIZE " hELLo "" hELLo "String
CAPITALIZE TRIM " hELLo ""HELLo"String
CAPITALIZE TRIM LOWERCASE " hELLo ""Hello"String
CAPITALIZE ( "hello" , TRUE )"Hello"String
CAPITALIZE ( "WORLD" , TRUE )"World"String
CAPITALIZE ( "hello world " , TRUE )"Hello world "String
CAPITALIZE ( " hELLo " , TRUE )" hello "String
CAPITALIZE ( TRIM " hELLo " , TRUE )"Hello"String
CAPITALIZE( ? )?String



Back to Top

TRIM


TRIM strips the leading and trailing spaces from a string 


Syntax

TRIM string



Input

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


Return type

  • string


Example

ExpressionResultType
TRIM "Hello""Hello"String
TRIM ( "Hello World" )"Hello World"String
TRIM "   Hello   World   ""Hello   World"String
TRIM ( ? )?String


Back to Top

INDEXOF


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


Syntax

INDEXOF ( string , substring )
INDEXOF ( string , substring , startIndex )


Inputs

  • 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

ExpressionResultType
INDEXOF ( "Hello world" , "o" )4Integer
INDEXOF ( "Hello world" , "o" , 5 )7Integer
INDEXOF ( "Hello world" , "a" )-1Integer
INDEXOF ( "Hello world" , "o" , 8 )-1Integer
INDEXOF ( "Hello world" , "o" , -12 )4Integer
INDEXOF ( "Hello world" , "o" , 50 )-1Integer



There is no restriction on the value of startIndex. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string: -1 is returned.


Back to Top

LASTINDEXOF


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


Syntax

LASTINDEXOF ( string , substring )
LASTINDEXOF ( string , substring , startIndex )


Inputs

  • 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

ExpressionResultType
LASTINDEXOF ( "Hello world" , "o" )7Integer
LASTINDEXOF ( "Hello world" , "o" , 6 )4Integer
LASTINDEXOF ( "Hello world" , "a" )-1Integer
LASTINDEXOF ( "Hello world" , "o" , 3 )-1Integer
LASTINDEXOF ( "Hello world" , "o" , -12 )-1Integer
LASTINDEXOF ( "Hello world" , "o" , 50 )7Integer



There is no restriction on the value of startIndex. If it is negative, it has the same effect as if it were zero: -1 is returned since there are no characters before character 0. If startIndex is greater than the length of this string, it has the same effect as if it were equal to the length of this string, so the whole string is searched.


Back to Top

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

SUBSTRING ( string , startIndex )
SUBSTRING ( string , startIndex , endIndex )


Inputs

  • 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

ExpressionResultType
SUBSTRING ( "Hello world" , 1 )"ello world"String
SUBSTRING ( "Hello world" , 0 , 1 )"H"String
SUBSTRING ( "Hello world" , 1 , 5 )"ello"String
SUBSTRING ( "Hello world" , 0 )"Hello world"String
SUBSTRING ( "Hello world" , 0 , LENGTH( "Hello world" ) )"Hello world"String



Back to Top

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

SUBSTRING BEFORE substring IN string
SUBSTRING_BEFORE ( string , substring )


Inputs

  • 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

ExpressionResultType
SUBSTRING BEFORE ":" IN "hello:world""hello"String
SUBSTRING_BEFORE ( "hello:world" , ":" )"hello"String

SUBSTRING_BEFORE ( "hello:world:all" , ":" )

"hello"String
SUBSTRING_BEFORE ( "hello:world" , "h" )""String
SUBSTRING BEFORE "a" IN "hello:world"""String
SUBSTRING_BEFORE ( "" , "hello" )""String
SUBSTRING_BEFORE ( "hello" , "" )""String



Back to Top

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

SUBSTRING AFTER substring IN string
SUBSTRING_AFTER ( string , substring )


Inputs

  • 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

ExpressionResultType
SUBSTRING AFTER ":" IN "hello:world""world"String
SUBSTRING_AFTER ( "hello:world:all" , ":" )"world:all"String
SUBSTRING AFTER "a" IN "hello:world"""String
SUBSTRING_AFTER ( "" , "hello" )""String
SUBSTRING_AFTER ( "hello" , "" )"hello"String



Back to Top

SPLIT


SPLIT returns a multivalued attribute containing every substring that is delimited by the given pattern. 


Syntax

SPLIT string ON pattern
SPLIT ( string , pattern )


Inputs

  • 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

ExpressionResultType
SPLIT "Hello world" ON "o"[ "Hell" , " w" , "rld" ]String (multivalued)
SPLIT ( "Hello world" , "a" )[ "Hello world" ]String (multivalued)
SPLIT "Hello" ON "o"[ "Hell" ]String (multivalued)
SPLIT ( "ooo" , "o" )[ ]String (multivalued)
SPLIT ( "bot" , "o" )[ "b" , "t" ]String (multivalued)
SPLIT ( "boot" , "o" )[ "b" , "", "t" ]String (multivalued)
SPLIT ( "booot" , "o" )[ "b" , "", "t" ]String (multivalued)
To remove dots from a string in combination with the JOIN function:
JOIN ( SPLIT ( "H.E.L.L.O" , "\.") , "" )"HELLO"String



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.


Back to Top

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

REPLACE pattern IN string WITH replacement
REPLACE ( pattern , string , replacement )



Inputs
  • 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

ExpressionResultType
REPLACE ":" IN  "hello:world:example" WITH " ""hello world example"String
REPLACE ( "o" , "hello world" , "a" )"hella warld"String
REPLACE ( "O" , "hello world" , "a" )"hello world"String
REPLACE "\s" IN "hello world example" WITH """helloworldexample"String
REPLACE ( "\d{2}" , "hello1 world22 example333" , "@" )"hello1 world@ example@3"String
REPLACE ( "" , "hello world" , " " )" h e l l o   w o r l d "String
REPLACE "\s" IN "hello world example" WITH "\s""hello\sworld\sexample"String



The first argument is a pattern (regular expression) and can therefore contain specials like \s for a space. The second and third arguments are strings or expressions, so \s will result in \s.



Back to Top


EQUALS


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


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

string1 EQUALS string2
EQUALS ( string1 , string2 )


Inputs

  • 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

ExpressionResultTypeNote
"hello" EQUALS "hello"TRUEBoolean
EQUALS ( "hello" , "Hello" )FALSEBooleanFALSE because EQUALS is case sensitive
"hello" EQUALS "hello "FALSEBooleanFALSE because of trailing space
EQUALS ( "" , "" )TRUEBoolean


Back to Top

 

  • No labels