Package net.pricefx.formulaengine.scripting.queryapi

Interface Expression

All Known Subinterfaces:

SelectableExpression

public interface Expression

An Expression used to specify either output values or logic criteria of a PipelineStage.

Expressions can be built:

• from a DefaultQueryApi.Column provided by a Tables.Table
• or from Exprs (via api.queryApi().exprs()) that gives access to Expressions building blocks

Expressions are not named by default, hence they cannot be directly added to an output columns list (that always needs a Selectable object). To do so, the as(String) method should be used. For example here is an example of an single stage pipeline using some expressions:

 def qapi = api.queryApi()
 def p = qapi.tables().products()
 qapi.source(
     p,
     [
         p.sku(), // a Column object
         qapi.exprs().string("foo").as("aStringLiteral"), // a literal expression built from Exprs
         p.sku().concat("bar").as("skuBar") // expression built from the column
         p.Cost().lessThan(5).as("veryInexpensive") // expression built from a column
     ],
     // a more complex expression
     qapi.exprs().and(
         p.sku().like("%foo"),
         p.Cost().lessThan(10)
     ) // no need to use `as()` here as only Expression object is expected (not Selectable)
 ).stream { it.each {
     row -> // row is a map having the following keys: ["sku", "aStringLiteral", "skuBar", "veryInexpensive"]
 }}
 

Since:

14.0 - Caribou Lou

Method Summary

Modifier and Type	Method	Description
SelectableExpression	as(String alias)	Builds a SelectableExpression having the same value as this expression and named after the given alias.
Expression	castAsBoolean()	Builds an expression that cast this expression to a boolean value.
Expression	castAsDateOnly()	Builds an expression that cast this expression to a date only value.
Expression	castAsDateTime()	Builds an expression that cast this expression to a datetime value.
Expression	castAsInteger()	Builds an expression that cast this expression to an integer value.
Expression	castAsReal()	Builds an expression that cast this expression to a real number value.
Expression	castAsString()	Builds an expression that cast this expression to a string value.
Expression	concat(String e)	Builds an expression that concatenates this expression to a given value.
Expression	concat(Expression e)	Builds an expression that concatenates this expression to a given value.
Expression	div(Number e)	Builds an expression that computes the value of this expression divided by the given value.
Expression	div(Expression e)	Builds an expression that computes the value of this expression divided by the given value.
Expression	equal(Boolean e)	Builds an expression evaluating if this expression is equal to the given boolean.
Expression	equal(Number e)	Builds an expression evaluating if this expression is equal to the given number.
Expression	equal(String e)	Builds an expression evaluating if this expression is equal to the given String.
Expression	equal(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is equal to the given date object.
Expression	equal(Date datetime)	Builds an expression evaluating if this expression is equal to the given datetime object.
Expression	equal(Expression e)	Builds an expression evaluating if this expression is equal to the given expression.
Expression	equal(DateTime datetime)	Builds an expression evaluating if this expression is equal to the given datetime object.
Expression	equalNullAware(Boolean e)	Builds an expression evaluating if this expression is equal to the given boolean.
Expression	equalNullAware(Number e)	Builds an expression evaluating if this expression is equal to the given number.
Expression	equalNullAware(String e)	Builds an expression evaluating if this expression is equal to the given String.
Expression	equalNullAware(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is equal to the given date object.
Expression	equalNullAware(Date datetime)	Builds an expression evaluating if this expression is equal to the given datetime object.
Expression	equalNullAware(Expression e)	Builds an expression evaluating if this expression is equal to the given expression.
Expression	equalNullAware(DateTime datetime)	Builds an expression evaluating if this expression is equal to the given datetime object.
Expression	greaterOrEqual(Number e)	Builds an expression evaluating if this expression is greater than or equal to the given number.
Expression	greaterOrEqual(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is greater than or equal to the given date object.
Expression	greaterOrEqual(Date datetime)	Builds an expression evaluating if this expression is greater than or equal to the given datetime object.
Expression	greaterOrEqual(Expression e)	Builds an expression evaluating if this expression is greater than or equal to the given expression.
Expression	greaterOrEqual(DateTime datetime)	Builds an expression evaluating if this expression is greater than or equal to the given datetime object.
Expression	greaterThan(Number e)	Builds an expression evaluating if this expression is strictly greater than the given number.
Expression	greaterThan(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is strictly greater than the given date object.
Expression	greaterThan(Date datetime)	Builds an expression evaluating if this expression is strictly greater than the given datetime object.
Expression	greaterThan(Expression e)	Builds an expression evaluating if this expression is strictly greater than the given expression.
Expression	greaterThan(DateTime datetime)	Builds an expression evaluating if this expression is strictly greater than the given datetime object.
Expression	ilike(String e)	Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.
Expression	ilike(Expression e)	Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.
Expression	in(List<?> e)	Builds an expression evaluating if this expression is equal to any of the element of the given list.
Expression	isFalse()	Builds an expression evaluating if this expression is false.
Expression	isNotNull()	Builds an expression evaluating if this expression is not null.
Expression	isNull()	Builds an expression evaluating if this expression is null.
Expression	isTrue()	Builds an expression evaluating if this expression is true.
Expression	length()	Builds an expression that computes the lenght of this expression as a String.
Expression	lessOrEqual(Number e)	Builds an expression evaluating if this expression is lower than or equal to the given number.
Expression	lessOrEqual(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is lower than or equal to the given date object.
Expression	lessOrEqual(Date datetime)	Builds an expression evaluating if this expression is lower than or equal to the given datetime object.
Expression	lessOrEqual(Expression e)	Builds an expression evaluating if this expression is lower than or equal to the given expression.
Expression	lessOrEqual(DateTime datetime)	Builds an expression evaluating if this expression is lower than or equal to the given datetime object.
Expression	lessThan(Number e)	Builds an expression evaluating if this expression is strictly lower than the given number.
Expression	lessThan(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is strictly lower than the given date object.
Expression	lessThan(Date datetime)	Builds an expression evaluating if this expression is strictly lower than the given datetime object.
Expression	lessThan(Expression e)	Builds an expression evaluating if this expression is strictly lower than the given expression.
Expression	lessThan(DateTime datetime)	Builds an expression evaluating if this expression is strictly lower than the given datetime object.
Expression	like(String e)	Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.
Expression	like(Expression e)	Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.
Expression	locate(String needle)	Builds an expression that computes the first position (1-based index) of the given String in this expression.
Expression	locate(Expression needle)	Builds an expression that computes the first position (1-based index) of the given String in this expression.
Expression	lower()	Builds an expression that computes a lower case version of this expression.
Expression	minus(Number e)	Builds an expression that computes the value of this expression minus the given value.
Expression	minus(Expression e)	Builds an expression that computes the value of this expression minus the given value.
Expression	mod(Number e)	Builds an expression that computes the value of the remainder of the Euclidean division of this expression by the given value.
Expression	mod(Expression e)	Builds an expression that computes the value of the remainder of the Euclidean division of this expression by the given value.
Expression	multiply(Number e)	Builds an expression that computes the value of this expression multiplied by the given value.
Expression	multiply(Expression e)	Builds an expression that computes the value of this expression multiplied by the given value.
Expression	notEqual(Boolean e)	Builds an expression evaluating if this expression is not equal to the given boolean.
Expression	notEqual(Number e)	Builds an expression evaluating if this expression is not equal to the given number.
Expression	notEqual(String e)	Builds an expression evaluating if this expression is not equal to the given String.
Expression	notEqual(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is not equal to the given date object.
Expression	notEqual(Date datetime)	Builds an expression evaluating if this expression is not equal to the given datetime object.
Expression	notEqual(Expression e)	Builds an expression evaluating if this expression is not equal to the given expression.
Expression	notEqual(DateTime datetime)	Builds an expression evaluating if this expression is not equal to the given datetime object.
Expression	notEqualNullAware(Boolean e)	Builds an expression evaluating if this expression is not equal to the given boolean.
Expression	notEqualNullAware(Number e)	Builds an expression evaluating if this expression is not equal to the given number.
Expression	notEqualNullAware(String e)	Builds an expression evaluating if this expression is not equal to the given String.
Expression	notEqualNullAware(LocalDate dateWithoutTime)	Builds an expression evaluating if this expression is not equal to the given date object.
Expression	notEqualNullAware(Date datetime)	Builds an expression evaluating if this expression is not equal to the given datetime object.
Expression	notEqualNullAware(Expression e)	Builds an expression evaluating if this expression is not equal to the given expression.
Expression	notEqualNullAware(DateTime datetime)	Builds an expression evaluating if this expression is not equal to the given datetime object.
Expression	notIlike(String e)	Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.
Expression	notIlike(Expression e)	Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.
Expression	notIn(List<?> e)	Builds an expression evaluating if this expression not equal to all the element of the given list.
Expression	notLike(String e)	Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.
Expression	notLike(Expression e)	Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.
Expression	plus(Number e)	Builds an expression that computes the value of this expression plus the given value.
Expression	plus(Expression e)	Builds an expression that computes the value of this expression plus the given value.
Expression	substring(int fromIndex, int length)	Builds an expression that computes a substring of this expression value.
Expression	substring(Expression fromIndex, Expression length)	Builds an expression that computes a substring of this expression value.
Expression	trim()	Builds an expression that computes this expression without any starting or ending white space characters.
Expression	upper()	Builds an expression that computes an upper case version of this expression.

Method Details

as

SelectableExpression as(String alias)

Builds a SelectableExpression having the same value as this expression and named after the given alias.

Parameters:

alias - the name of the selectable expression to return

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessThan

Expression lessThan(Expression e)

Builds an expression evaluating if this expression is strictly lower than the given expression.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - an expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessThan

Expression lessThan(Date datetime)

Builds an expression evaluating if this expression is strictly lower than the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessThan

Expression lessThan(DateTime datetime)

Builds an expression evaluating if this expression is strictly lower than the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessThan

Expression lessThan(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is strictly lower than the given date object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

dateWithoutTime - Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessThan

Expression lessThan(Number e)

Builds an expression evaluating if this expression is strictly lower than the given number.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the Number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessOrEqual

Expression lessOrEqual(Expression e)

Builds an expression evaluating if this expression is lower than or equal to the given expression.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - an expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessOrEqual

Expression lessOrEqual(Date datetime)

Builds an expression evaluating if this expression is lower than or equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessOrEqual

Expression lessOrEqual(DateTime datetime)

Builds an expression evaluating if this expression is lower than or equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessOrEqual

Expression lessOrEqual(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is lower than or equal to the given date object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

dateWithoutTime - Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

lessOrEqual

Expression lessOrEqual(Number e)

Builds an expression evaluating if this expression is lower than or equal to the given number.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the Number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterThan

Expression greaterThan(Expression e)

Builds an expression evaluating if this expression is strictly greater than the given expression.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - an expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterThan

Expression greaterThan(Date datetime)

Builds an expression evaluating if this expression is strictly greater than the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterThan

Expression greaterThan(DateTime datetime)

Builds an expression evaluating if this expression is strictly greater than the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterThan

Expression greaterThan(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is strictly greater than the given date object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

dateWithoutTime - Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterThan

Expression greaterThan(Number e)

Builds an expression evaluating if this expression is strictly greater than the given number.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the Number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterOrEqual

Expression greaterOrEqual(Expression e)

Builds an expression evaluating if this expression is greater than or equal to the given expression.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - an expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterOrEqual

Expression greaterOrEqual(Date datetime)

Builds an expression evaluating if this expression is greater than or equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterOrEqual

Expression greaterOrEqual(DateTime datetime)

Builds an expression evaluating if this expression is greater than or equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterOrEqual

Expression greaterOrEqual(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is greater than or equal to the given date object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

dateWithoutTime - Date object to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

greaterOrEqual

Expression greaterOrEqual(Number e)

Builds an expression evaluating if this expression is greater than or equal to the given number.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the Number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(Expression e)

Builds an expression evaluating if this expression is equal to the given expression.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(String e)

Builds an expression evaluating if this expression is equal to the given String.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the String to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(Date datetime)

Builds an expression evaluating if this expression is equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(DateTime datetime)

Builds an expression evaluating if this expression is equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is equal to the given date object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

dateWithoutTime - the date to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(Number e)

Builds an expression evaluating if this expression is equal to the given number.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equal

Expression equal(Boolean e)

Builds an expression evaluating if this expression is equal to the given boolean.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the boolean to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(Expression e)

Builds an expression evaluating if this expression is equal to the given expression.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

e - the expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(String e)

Builds an expression evaluating if this expression is equal to the given String.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

e - the String to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(Date datetime)

Builds an expression evaluating if this expression is equal to the given datetime object.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(DateTime datetime)

Builds an expression evaluating if this expression is equal to the given datetime object.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is equal to the given date object.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

dateWithoutTime - the date to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(Number e)

Builds an expression evaluating if this expression is equal to the given number.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

e - the number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

equalNullAware

Expression equalNullAware(Boolean e)

Builds an expression evaluating if this expression is equal to the given boolean.

This null aware version will return

• true if this expression and the given value are both null
• false if only one of this expression or the given value is null
• otherwise it will return the result of the normal equality

Parameters:

e - the boolean to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(Expression e)

Builds an expression evaluating if this expression is not equal to the given expression.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(String e)

Builds an expression evaluating if this expression is not equal to the given String.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the String to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(Date datetime)

Builds an expression evaluating if this expression is not equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(DateTime datetime)

Builds an expression evaluating if this expression is not equal to the given datetime object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is not equal to the given date object.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

dateWithoutTime - the date to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(Number e)

Builds an expression evaluating if this expression is not equal to the given number.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqual

Expression notEqual(Boolean e)

Builds an expression evaluating if this expression is not equal to the given boolean.

If this expression or the given value is null then this expression will evaluate to null

Parameters:

e - the boolean to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(Expression e)

Builds an expression evaluating if this expression is not equal to the given expression.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

e - the expression to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(String e)

Builds an expression evaluating if this expression is not equal to the given String.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

e - the String to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(Date datetime)

Builds an expression evaluating if this expression is not equal to the given datetime object.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(DateTime datetime)

Builds an expression evaluating if this expression is not equal to the given datetime object.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

datetime - the datetime to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(LocalDate dateWithoutTime)

Builds an expression evaluating if this expression is not equal to the given date object.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

dateWithoutTime - the date to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(Number e)

Builds an expression evaluating if this expression is not equal to the given number.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

e - the number to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

notEqualNullAware

Expression notEqualNullAware(Boolean e)

Builds an expression evaluating if this expression is not equal to the given boolean.

This null aware version will return

• false if this expression and the given value are both null
• true if only one of this expression or the given value is null
• otherwise it will return the result of the normal non equality

Parameters:

e - the boolean to be compared with this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

like

Expression like(Expression e)

Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.

This operator is case-sensitive.

Specification of the pattern can be find on w3shcools website or on the PosgreSQL official documentation.

As an example qapi.tables().products().sku().like("%foo%") will be true for any sku containing the "foo" string.

Parameters:

e - an expression providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• ilike(Expression)
• notLike(Expression)
• notIlike(Expression)

like

Expression like(String e)

Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.

This operator is case-sensitive.

Specification of the pattern can be find on w3shcools website or on the PosgreSQL official documentation.

As an example qapi.tables().products().sku().like("%foo%") will be true for any sku containing the "foo" string.

Parameters:

e - a string providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• ilike(String)
• notLike(String)
• notIlike(String)

ilike

Expression ilike(Expression e)

Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.

This operator is case-insensitive.

Specification of the pattern can be find on w3shcools website or on the PosgreSQL official documentation.

As an example qapi.tables().products().sku().like("%foo%") will be true for any sku containing the "foo" string with any combination of upper or lower case characters.

Parameters:

e - an expression providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• like(Expression)
• notLike(Expression)
• notIlike(Expression)

ilike

Expression ilike(String e)

Builds an expression evaluating if this expression is matching the standard SQL LIKE pattern provided by the given value.

This operator is case-insensitive.

Specification of the pattern can be find on w3shcools website or on the PosgreSQL official documentation.

As an example qapi.tables().products().sku().like("%foo%") will be true for any sku containing the "foo" string with any combination of upper or lower case characters.

Parameters:

e - a string providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• like(String)
• notLike(String)
• notIlike(String)

notLike

Expression notLike(Expression e)

Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.

This operator is case-sensitive.

Parameters:

e - a string providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• like(Expression)
• ilike(Expression)
• notIlike(Expression)

notLike

Expression notLike(String e)

Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.

This operator is case-sensitive.

Parameters:

e - a string providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• like(String)
• ilike(String)
• notIlike(String)

notIlike

Expression notIlike(Expression e)

Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.

This operator is case-insensitive.

Parameters:

e - a string providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• like(Expression)
• ilike(Expression)
• notLike(Expression)

notIlike

Expression notIlike(String e)

Builds an expression evaluating if this expression is not matching the standard SQL LIKE pattern provided by the given value.

This operator is case-insensitive.

Parameters:

e - a string providing given standard SQL LIKE pattern

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• like(String)
• ilike(String)
• notLike(String)

in

Expression in(List<?> e)

Builds an expression evaluating if this expression is equal to any of the element of the given list.

Works only with homogenous lists containing elements of the following types: String, Number, Boolean (note that it does not work with Date, org.joda.time.DateTime, java.time.LocalDate)

Parameters:

e - the list of value to be compared to this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• notIn(List)

notIn

Expression notIn(List<?> e)

Builds an expression evaluating if this expression not equal to all the element of the given list.

Works only with homogenous lists containing elements of the following types: String, Number, Boolean (note that it does not work with Date, org.joda.time.DateTime, java.time.LocalDate)

Parameters:

e - the list of value to be compared to this expression

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• in(List)

isNull

Expression isNull()

Builds an expression evaluating if this expression is null.

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• isNotNull()

isNotNull

Expression isNotNull()

Builds an expression evaluating if this expression is not null.

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• isNotNull()

isTrue

Expression isTrue()

Builds an expression evaluating if this expression is true.

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• isFalse()

isFalse

Expression isFalse()

Builds an expression evaluating if this expression is false.

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• isTrue()

castAsString

Expression castAsString()

Builds an expression that cast this expression to a string value.

Returns:

the built expression

Since:

14.0 - Caribou Lou

castAsReal

Expression castAsReal()

Builds an expression that cast this expression to a real number value.

Returns:

the built expression

Since:

14.0 - Caribou Lou

castAsInteger

Expression castAsInteger()

Builds an expression that cast this expression to an integer value.

Returns:

the built expression

Since:

14.0 - Caribou Lou

castAsBoolean

Expression castAsBoolean()

Builds an expression that cast this expression to a boolean value.

Returns:

the built expression

Since:

14.0 - Caribou Lou

castAsDateOnly

Expression castAsDateOnly()

Builds an expression that cast this expression to a date only value.

Returns:

the built expression

Since:

14.0 - Caribou Lou

castAsDateTime

Expression castAsDateTime()

Builds an expression that cast this expression to a datetime value.

Returns:

the built expression

Since:

14.0 - Caribou Lou

concat

Expression concat(Expression e)

Builds an expression that concatenates this expression to a given value.

Parameters:

e - the expression to be concatenated

Returns:

the built expression

Since:

14.0 - Caribou Lou

concat

Expression concat(String e)

Builds an expression that concatenates this expression to a given value.

Parameters:

e - the String to be concatenated

Returns:

the built expression

Since:

14.0 - Caribou Lou

substring

Expression substring(Expression fromIndex,
 Expression length)

Builds an expression that computes a substring of this expression value.

fromIndex should be a 1-based index as a result:

 qapi.exprs().string("fooBar").subString(1, 4) // evaluates to "fooB"
 qapi.exprs().string("fooBar").subString(4, 10) // evaluates to "Bar"
 

Parameters:

fromIndex - the 1-based index start of the substring to extract

length - the max length of the substring to extract

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• substring(int, int)

substring

Expression substring(int fromIndex,
 int length)

Builds an expression that computes a substring of this expression value.

fromIndex should be a 1-based index as a result:

 qapi.exprs().string("fooBar").subString(1, 4) // evaluates to "fooB"
 qapi.exprs().string("fooBar").subString(4, 10) // evaluates to "Bar"
 

Parameters:

fromIndex - the 1-based index start of the substring to extract

length - the max length of the substring to extract

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• substring(Expression, Expression)

upper

Expression upper()

Builds an expression that computes an upper case version of this expression.

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• lower()

lower

Expression lower()

Builds an expression that computes a lower case version of this expression.

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• lower()

trim

Expression trim()

Builds an expression that computes this expression without any starting or ending white space characters.

 qapi.exprs().string("  fooBar  \t ").trim() // evaluates to "fooBar", removes trailing and starting tabs and spaces
 

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• lower()

length

Expression length()

Builds an expression that computes the lenght of this expression as a String.

Returns:

the build expression

Since:

14.0 - Caribou Lou

locate

Expression locate(Expression needle)

Builds an expression that computes the first position (1-based index) of the given String in this expression.

Parameters:

needle - the expression of the String to be searched

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• locate(String)

locate

Expression locate(String needle)

Builds an expression that computes the first position (1-based index) of the given String in this expression.

Parameters:

needle - the String to be searched

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• locate(Expression)

plus

Expression plus(Expression e)

Builds an expression that computes the value of this expression plus the given value.

Parameters:

e - the expression to be added

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• plus(Number)

plus

Expression plus(Number e)

Builds an expression that computes the value of this expression plus the given value.

Parameters:

e - the Number to be added

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• plus(Expression)

minus

Expression minus(Expression e)

Builds an expression that computes the value of this expression minus the given value.

Parameters:

e - the expression to be subtracted

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• minus(Number)

minus

Expression minus(Number e)

Builds an expression that computes the value of this expression minus the given value.

Parameters:

e - the Number to be subtracted

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• minus(Expression)

multiply

Expression multiply(Expression e)

Builds an expression that computes the value of this expression multiplied by the given value.

Parameters:

e - the factor to be multiplied with

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• multiply(Number)

multiply

Expression multiply(Number e)

Builds an expression that computes the value of this expression multiplied by the given value.

Parameters:

e - the factor to be multiplied with

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• multiply(Expression)

div

Expression div(Expression e)

Builds an expression that computes the value of this expression divided by the given value.

Parameters:

e - the divisor

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• div(Number)

div

Expression div(Number e)

Builds an expression that computes the value of this expression divided by the given value.

Parameters:

e - the divisor

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• div(Expression)

mod

Expression mod(Expression e)

Builds an expression that computes the value of the remainder of the Euclidean division of this expression by the given value.

Parameters:

e - the divisor

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• mod(Number)

mod

Expression mod(Number e)

Builds an expression that computes the value of the remainder of the Euclidean division of this expression by the given value.

Parameters:

e - the divisor

Returns:

the built expression

Since:

14.0 - Caribou Lou

See Also:

• mod(Expression)