Deem Java Expression

This transform allows you to enter User Defined Java Expressions as a basis for the calculation of new values.

This step have the same functionality as the standard “User Defined Java Expressions” transform, but have support for some extra “tools”

If you have a Java expression like:

C=A+B

Then you can simply enter the right side of the expression in the dialog:

A+B

The values are exposed to the expressions as the Java objects they are:

Data type	Java Class
String	java.lang.String
Integer	java.lang.Long
Number	java.lang.Double
Date	java.util.Date
BigNumber	BigDecimal
Binary	byte[]

Options

Option	Description
New Field	The new field in the data stream. If you want to overwrite an existing field, you need to define the field here and in the “Replace value” option.
Java Expression	The Java Expression, see examples below
Value Type	Type
Length	Length
Precision	Precision
Replace value	Select this identical to the “New field” name when you want to replace the

Examples

Add 2 integers, A and B

A+B

Concatenate 2 Strings

firstname and name and put a space in between

firstname+" "+name

or if you really care about performance, this might be faster:

new StringBuffer(firstname).append(" ").append(name).toString()

Set the first character of each word in upper-case

john doe —> John Doe

org.pentaho.di.core.Const.initCap(name)

Use native Java and API functions

System.getProperty("os.name")

Business rules (If / Then / Else)

When a<c then return true else return false

a<c?true:false

This can be more complicated

a<c?(a==1?1:2):3

even with OR and AND and other operators and functions

Using Constants

If you use a constant, you may need to define the right type in some expressions otherwise it could throw:

Incompatible expression types “int” and “java.lang.Long”

To solve this, use:

test == null ? new Long(0) : test

In this case, it checks if test is null and replaces with zero. If it is not null, it will return test.

Cut a string from end and test for null and minimal length

Imagine you have input strings with

• Orlando FL
• New York NY

and you want to separate the state and city, you could use the following expressions:

For state (get the last 2 characters):

location != null && location.length()>2 ? location.substring(location.length()-2, location.length()) : null

For city (get the beginning without the last 2 characters and trim):

location != null && location.length()>2 ? location.substring(0, location.length()-2).trim() : location

Functionality of a LIKE operator (contains string) and replacing values

The following example returns 1 when abc is within the source string, otherwise 2. It returns also 2 when the source string is null. The return values could be of value type Integer.

samplestr !=null && samplestr.indexOf("abc")>-1 ? 1 : 2

Method Summary (ZTools)

All Methods

Modifier and Type	Method and Description
String	abbreviate(String str, int maxWidth) Abbreviates a String using ellipses.
String	abbreviat(String str, int offset, int maxWidth) Abbreviates a String using ellipses.
String	abbreviateMiddle(String str, String middle, int length) Abbreviates a String to the length passed, replacing the middle characters with the supplied replacement String.
Date	addDays(Date date, int amount) Adds a number of days to a date returning a new object.
Date	addHours(Date date, int amount) Adds a number of hours to a date returning a new object.
Date	addMilliseconds(Date date, int amount) Adds a number of milliseconds to a date returning a new object.
Date	addMinutes(Date date, int amount) Adds a number of minutes to a date returning a new object.
Date	addMonths(Date date, int amount) Adds a number of months to a date returning a new object.
Date	addSeconds(Date date, int amount) Adds a number of seconds to a date returning a new object.
Date	addWeeks(Date date, int amount) Adds a number of weeks to a date returning a new object.
Date	addYears(Date date, int amount) Adds a number of years to a date returning a new object.
String	capitalieAllWords(String str) Capitalizes all the whitespace separated words in a String.
String	capitalize(String str) Capitalizes a String changing the first letter to title case as per Character.toTitleCase(char).
Calendar	ceiling(Calendar date, int field) Ceil this date, leaving the field specified as the most significant field.
Date	ceiling(Date date, int field) Ceil this date, leaving the field specified as the most significant field.
Date	ceiling(Object date, int field) Ceil this date, leaving the field specified as the most significant field.
String	center(String str, int size) Centers a String in a larger String of size size using the space character (’ ’).
String	center(String str, int size, char padChar) Centers a String in a larger String of size size.
String	center(String str, int size, String padStr) Centers a String in a larger String of size size.
String	chomp(String str) Removes one newline from end of a String if it’s there, otherwise leave it alone.
String	chomp(String str, String separator) Removes separator from the end of str if it’s there, otherwise leave it alone.
String	chop(String str) Remove the last character from a String.
boolean	contains(String str, char searchChar) Checks if String contains a search character, handling null.
boolean	contains(String str, String searchStr) Checks if String contains a search String, handling null.
boolean	containsAny(String str, char[] searchChars) Checks if the String contains any character in the given set of characters.
boolean	containsAny(String str, String searchChars) Checks if the String contains any character in the given set of characters.
boolean	containsIgnoreCase(String str, String searchStr) hecks if String contains a search String irrespective of case, handling null.
boolean	containsNone(String str, char[] invalidChars) Checks that the String does not contain certain characters.
boolean	containsNone(String str, String invalidChars) Checks that the String does not contain certain characters.
boolean	containsOnly(String str, char[] valid) Checks if the String contains only certain characters.
boolean	containsOnly(String str, String validChars) Checks if the String contains only certain characters.
int	countMatches(String str, String sub) Counts how many times the substring appears in the larger String.
String	defaultIfBlank(String str, String defaultStr) Returns either the passed in String, or if the String is empty or null, the value of defaultStr.
String	defaultIfEmpty(String str, String defaultStr) Returns either the passed in String, or if the String is empty or null, the value of defaultStr.
Object	defaultLong(Long obj, Long defaultObj)
Object	defaultObject(String obj, Object defaultObj)
String	defaultString(String str) Returns either the passed in String, or if the String is null, an empty String ("").
String	defaultString(String str, String defaultStr) Returns either the passed in String, or if the String is null, the value of defaultStr.
String	deleteWhitespace(String str) Deletes all whitespaces from a String as defined by Character.isWhitespace(char).
String	difference(String str1, String str2) Compares two Strings, and returns the portion where they differ.
boolean	endsWith(String str, String suffix) Check if a String ends with a specified suffix.
boolean	endsWithIgnoreCase(String str, String suffix) Case insensitive check if a String ends with a specified suffix.
boolean	equals(String str1, String str2) Compares two Strings, returning true if they are equal.
boolean	equalsIgnoreCase(String str1, String str2) Compares two Strings, returning true if they are equal ignoring the case.
String	formatDate(Date date, String format)
String	getCommonPrefix(String[] strs) Compares all Strings in an array and returns the initial sequence of characters that is common to all of them.
Date	getDate() Returns today as a Date object.
Integer	getDayOfMonth()
Integer	getDayOfMonth(Date date)
Integer	getDayOfWeek()
Integer	getDayOfWeek(Date date)
Integer	getHourOfDay(Date date)
int	getLevenshteinDistance(String s, String t) Find the Levenshtein distance between two Strings.
Integer	getMonth()
Integer	getMonth(Date date)
Integer	getMonthNo()
Integer	getMonthNo(Date date)
Integer	getWeek()
Integer	getWeek(Date date)
Integer	getWeek52()
Integer	getWeek52(Date date)
Integer	getWeekNo()
Integer	getWeekNo(Date date)
Integer	getWeekNo52()
Integer	getWeekNo52(Date date)
Integer	getYear()
Integer	getYear(Date date)
Integer	getYMD8() Returns today in YMD8 integer format.
int	indexOf(String str, String searchStr) Finds the first index within a String, handling null.
int	indexOf(String str, String searchStr, int startPos) Finds the first index within a String, handling null.
int	indexOfAny(String str, String[] searchStrs) Find the first index of any of a set of potential substrings.
int	indexOfAnyBut(String str, char[] searchChars) Search a String to find the first index of any character not in the given set of characters.
int	indexOfAnyBut(String str, String searchChars) Search a String to find the first index of any character not in the given set of characters.
int	indexOfDifference(String[] strs) Compares all Strings in an array and returns the index at which the Strings begin to differ.
int	indexOfDifference(String str1, String str2) Compares two Strings, and returns the index at which the Strings begin to differ.
boolean	sAllLowerCase(String str) Checks if the String contains only lowercase characters.
boolean	isAllUpperCase(String str) Checks if the String contains only uppercase characters.
boolean	isAlpha(String str) Checks if the String contains only unicode letters.
boolean	isAlphanumeric(String str) Checks if the String contains only unicode letters or digits.
boolean	isAlphanumericSpace(String str) Checks if the String contains only unicode letters, digits or space (’ ‘).
boolean	isAlphaSpace(String str) Checks if the String contains only unicode letters and space (’ ‘).
boolean	isAsciiPrintable(String str) Checks if the string contains only ASCII printable characters.
boolean	isBetween(String lowerBound, String upperBound, String value)
boolean	isBlank(String str) Checks if a String is whitespace, empty ("") or null.
boolean	isEmpty(String str) Checks if a String is empty ("") or null.
boolean	isNotBlank(String str) Checks if a String is not empty (""), not null and not whitespace only.
boolean	isNotEmpty(String str) Checks if a String is not empty ("") and not null.
boolean	isNumeric(String str) Checks if the String contains only unicode digits.
boolean	isNumericSpace(String str) Checks if the String contains only unicode digits or space (’ ‘).
boolean	isSameDay(Calendar cal1, Calendar cal2) Checks if two calendar objects are on the same day ignoring time.
boolean	isSameDay(Date date1, Date date2) Checks if two date objects are on the same day ignoring time.
boolean	isSameInstant(Calendar cal1, Calendar cal2) Checks if two calendar objects represent the same instant in time.
boolean	isSameInstant(Date date1, Date date2) Checks if two date objects represent the same instant in time.
boolean	isSameLocalTime(Calendar cal1, Calendar cal2) Checks if two calendar objects represent the same local time.
boolean	isWhitespace(String str) Checks if the String contains only whitespace.
int	lastIndexOf(String str, String searchStr) Finds the last index within a String, handling null.
int	lastIndexOf(String str, String searchStr, int startPos) Finds the first index within a String, handling null.
int	lastIndexOfIgnoreCase(String str, String searchStr) Case in-sensitive find of the last index within a String.
int	lastIndexOfIgnoreCase(String str, String searchStr, int startPos) Case in-sensitive find of the last index within a String from the specified position.
int	lastOrdinalIndexOf(String str, String searchStr, int ordinal) Finds the n-th last index within a String, handling null.
String	left(String str, int len) Gets the leftmost len characters of a String.
String	leftPad(String str, int size) Left pad a String with spaces (’ ’).
String	leftPad(String str, int size, char padChar) Left pad a String with a specified character.
String	leftPad(String str, int size, String padStr) Left pad a String with a specified String.
int	#length-java.lang.String-[length(String str)Gets a String’s length or 0 if the String is null.
String	lowerCase(String str) Converts a String to lower case as per String.toLowerCase().
String	lowerCase(String str, Locale locale) Converts a String to lower case as per String.toLowerCase(Locale).
String	mid(String str, int pos, int len) Gets len characters from the middle of a String.
Date	now() Returns today as a Date object.
Integer	nowYMD8() Returns today in YMD8 Integer format
int	ordinalIndexOf(String str, String searchStr, int ordinal) Finds the n-th index within a String, handling null.
String	overlay(String str, String overlay, int start, int end) Overlays part of a String with another String.
Date	parseDate(String str, String[] parsePatterns) Parses a string representing a date by trying a variety of different parsers.
Date	parseDateStrictly(String str, String[] parsePatterns) Parses a string representing a date by trying a variety of different parsers.
String	remove(String str, char remove) Removes all occurrences of a character from within the source string.
String	remove(String str, String remove) Removes all occurrences of a substring from within the source string.
String	removeEnd(String str, String remove) Removes a substring only if it is at the end of a source string, otherwise returns the source string.
String	removeEndIgnoreCase(String str, String remove) Case insensitive removal of a substring if it is at the end of a source string, otherwise returns the source string.
String	removeStart(String str, String remove) Removes a substring only if it is at the begining of a source string, otherwise returns the source string.
String	removeStartIgnoreCase(String str, String remove) Case insensitive removal of a substring if it is at the begining of a source string, otherwise returns the source string.
String	repeat(String str, int repeat) Repeat a String repeat times to form a new String.
String	repeat(String str, String separator, int repeat) Repeat a String repeat times to form a new String, with a String separator injected each time.
String	replace(String text, String searchString, String replacement) Replaces all occurrences of a String within another String.
String	replace(String text, String searchString, String replacement, int max) Replaces a String with another String inside a larger String, for the first max values of the search String.
String	replaceOnce(String text, String searchString, String replacement) Replaces a String with another String inside a larger String, once.
String	reverse(String str) Reverses a String as per StringBuffer.reverse().
String	right(String str, int len) Gets the rightmost len characters of a String.
String	rightPad(String str, int size) Right pad a String with spaces (’ ’).
String	rightPad(String str, int size, char padChar) Right pad a String with a specified character.
String	rightPad(String str, int size, String padStr) Right pad a String with a specified String.
Calendar	round(Calendar date, int field) Round this date, leaving the field specified as the most significant field.
Date	round(Date date, int field) Round this date, leaving the field specified as the most significant field.
Date	round(Object date, int field) Round this date, leaving the field specified as the most significant field.
Date	setDate(int m3Date)Set date based upon YMD8 formated int.
Date	setDate(Integer m3Date)Set date based upon YMD8 formated int.
Date	setDate(int m3Date, int m3Time) Set date based upon YMD8 formated date and HHMMSS formated time.
Date	setDate(Long m3Date) Set date based upon YMD8 formated int.
Date	setDate(Long m3Date, Long m3Time) Set date based upon YMD8 formated date and HHMMSS formated time.
Date	setDays(Date date, int amount) Sets the day of month field to a date returning a new object.
Date	setHours(Date date, int amount) Sets the hours field to a date returning a new object.
Date	setMilliseconds(Date date, int amount) Sets the miliseconds field to a date returning a new object.
Date	setMinutes(Date date, int amount) Sets the minute field to a date returning a new object.
Date	setMonths(Date date, int amount) Sets the months field to a date returning a new object.
Date	setSeconds(Date date, int amount) Sets the seconds field to a date returning a new object.
Date	setTime(int m3Time)
Date	setTime(Long m3Time) Set time based upon HHMMSS formated time.
Date	setYears(Date date, int amount) Sets the years field to a date returning a new object.
String[]	split(String str) Splits the provided text into an array, using whitespace as the separator.
String[]	split(String str, char separatorChar) Splits the provided text into an array, separator specified.
String[]	split(String str, String separatorChars) Splits the provided text into an array, separators specified.
String[]	split(String str, String separatorChars, int max) Splits the provided text into an array with a maximum length, separators specified.
String[]	splitPreserveAllTokens(String str) Splits the provided text into an array, using whitespace as the separator, preserving all tokens, including empty tokens created by adjacent separators.
String[]	splitPreserveAllTokens(String str, char separatorChar) Splits the provided text into an array, separator specified, preserving all tokens, including empty tokens created by adjacent separators.
String[]	splitPreserveAllTokens(String str, String separatorChars) Splits the provided text into an array, separators specified, preserving all tokens, including empty tokens created by adjacent separators.
String[]	splitPreserveAllTokens(String str, String separatorChars, int max) Splits the provided text into an array with a maximum length, separators specified, preserving all tokens, including empty tokens created by adjacent separators.
boolean	startsWith(String str, String prefix) Check if a String starts with a specified prefix.
boolean	startsWithAny(String string, String[] searchStrings) Check if a String starts with any of an array of specified strings.
boolean	startsWithIgnoreCase(String str, String prefix) Case insensitive check if a String starts with a specified prefix.
String	strip(String str) Strips whitespace from the start and end of a String.
String	strip(String str, String stripChars) Strips any of a set of characters from the start and end of a String.
String	stripEnd(String str, String stripChars) Strips any of a set of characters from the end of a String.
String	stripStart(String str, String stripChars) Strips any of a set of characters from the start of a String.
String	stripToEmpty(String str) Strips whitespace from the start and end of a String returning an empty String if null input.
String	stripToNull(String str) Strips whitespace from the start and end of a String returning null if the String is empty ("") after the strip.
String	substring(String str, int start) Gets a substring from the specified String avoiding exceptions.
String	substring(String str, int start, int end) Gets a substring from the specified String avoiding exceptions.
String	substringAfter(String str, String separator) Gets the substring after the first occurrence of a separator.
String	substringAfterLast(String str, String separator) Gets the substring after the last occurrence of a separator.
String	substringBefore(String str, String separator) Gets the substring before the first occurrence of a separator.
String	substringBeforeLast(String str, String separator) Gets the substring before the last occurrence of a separator.
String	substringBetween(String str, String tag) Gets the String that is nested in between two instances of the same String.
String	substringBetween(String str, String open, String close) Gets the String that is nested in between two Strings.
String	swapCase(String str) Swaps the case of a String changing upper and title case to lower case, and lower case to upper case.
Double	toDouble(Object value)
String	toHH_HH(Date date) Convert a date to the HH-HH format.
String	toHHMM(Date date) Convert a date to the HH:MM format (Hour:Minutes)
Integer	toInteger(Object value)
String	toString(Object value)
Integer	toYMD8(Date date) Returns today in YMD8 integer format.
String	trim(String str) Removes control characters (char <= 32) from both ends of this String, handling null by returning null.
String	trimToEmpty(String str) Removes control characters (char <= 32) from both ends of this String returning an empty String ("") if the String is empty ("") after the trim or if it is null.
String	trimToNull(String str) Removes control characters (char <= 32) from both ends of this String returning null if the String is empty ("") after the trim or if it is null.
Calendar	truncate(Calendar date, int field) Truncate this date, leaving the field specified as the most significant field.
Date	truncate(Date date, int field) Truncate this date, leaving the field specified as the most significant field.
Date	truncate(Object date, int field) Truncate this date, leaving the field specified as the most significant field.
String	uncapitalize(String str) Uncapitalizes a String changing the first letter to title case as per Character.toLowerCase(char).
String	upperCase(String str) Converts a String to upper case as per String.toUpperCase().
String	upperCase(String str, Locale locale) Converts a String to upper case as per String.toUpperCase(Locale).