Interface TextExpression

All Superinterfaces:

ComparableExpression<String>, Expression<String>, Selection<String>, TupleElement<String>

public interface TextExpression
extends ComparableExpression<String>

Type for string query expressions.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
TextExpression	append(Expression<String> y)	Create an expression for string concatenation.
TextExpression	append(String y)	Create an expression for string concatenation.
TextExpression	coalesce(Expression<? extends String> y)	Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.
TextExpression	coalesce(String y)	Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.
Predicate	contains(String substring)	Create a predicate for testing whether this expression contains the given substring.
Predicate	endsWith(String suffix)	Create a predicate for testing whether this expression ends with the given suffix.
TextExpression	left(int len)	Create an expression for the leftmost substring of this string.
TextExpression	left(Expression<Integer> len)	Create an expression for the leftmost substring of this string.
Expression<Integer>	length()	Create expression to return length of this string.
Predicate	like(Expression<String> pattern)	Create a predicate for testing whether this expression satisfies the given pattern.
Predicate	like(Expression<String> pattern, char escapeChar)	Create a predicate for testing whether this expression satisfies the given pattern.
Predicate	like(Expression<String> pattern, Expression<Character> escapeChar)	Create a predicate for testing whether this expression satisfies the given pattern.
Predicate	like(String pattern)	Create a predicate for testing whether this expression satisfies the given pattern.
Predicate	like(String pattern, char escapeChar)	Create a predicate for testing whether this expression satisfies the given pattern.
Predicate	like(String pattern, Expression<Character> escapeChar)	Create a predicate for testing whether this expression satisfies the given pattern.
NumericExpression<Integer>	locate(Expression<String> pattern)	Create expression to locate the position of one string within this, returning position of first character if found.
NumericExpression<Integer>	locate(Expression<String> pattern, Expression<Integer> from)	Create expression to locate the position of one string within this, returning position of first character if found.
NumericExpression<Integer>	locate(String pattern)	Create expression to locate the position of one string within this, returning position of first character if found.
NumericExpression<Integer>	locate(String pattern, int from)	Create expression to locate the position of one string within this, returning position of first character if found.
TextExpression	lower()	Create expression for converting this string to lowercase.
Predicate	notContains(String substring)	Create a predicate for testing whether this expression does not contain the given substring.
Predicate	notEndsWith(String suffix)	Create a predicate for testing whether this expression does not end with the given suffix.
Predicate	notLike(Expression<String> pattern)	Create a predicate for testing whether this expression does not satisfy the given pattern.
Predicate	notLike(Expression<String> pattern, char escapeChar)	Create a predicate for testing whether this expression does not satisfy the given pattern.
Predicate	notLike(Expression<String> pattern, Expression<Character> escapeChar)	Create a predicate for testing whether this expression does not satisfy the given pattern.
Predicate	notLike(String pattern)	Create a predicate for testing whether this expression does not satisfy the given pattern.
Predicate	notLike(String pattern, char escapeChar)	Create a predicate for testing whether this expression does not satisfy the given pattern.
Predicate	notLike(String pattern, Expression<Character> escapeChar)	Create a predicate for testing whether this expression does not satisfy the given pattern.
Predicate	notStartsWith(String prefix)	Create a predicate for testing whether this expression does not start with the given prefix.
TextExpression	nullif(Expression<? extends String> y)	Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.
TextExpression	nullif(String y)	Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.
TextExpression	prepend(Expression<String> y)	Create an expression for string concatenation.
TextExpression	prepend(String y)	Create an expression for string concatenation.
TextExpression	replace(Expression<String> substring, Expression<String> replacement)	Create an expression replacing every occurrence of a substring within this string.
TextExpression	replace(Expression<String> substring, String replacement)	Create an expression replacing every occurrence of a substring within this string.
TextExpression	replace(String substring, Expression<String> replacement)	Create an expression replacing every occurrence of a substring within this string.
TextExpression	replace(String substring, String replacement)	Create an expression replacing every occurrence of a substring within this string.
TextExpression	right(int len)	Create an expression for the rightmost substring of this string.
TextExpression	right(Expression<Integer> len)	Create an expression for the rightmost substring of this string.
Predicate	startsWith(String prefix)	Create a predicate for testing whether this expression starts with the given prefix.
TextExpression	substring(int from)	Create an expression for substring extraction.
TextExpression	substring(int from, int len)	Create an expression for substring extraction.
TextExpression	substring(Expression<Integer> from)	Create an expression for substring extraction.
TextExpression	substring(Expression<Integer> from, Expression<Integer> len)	Create an expression for substring extraction.
TextExpression	trim()	Create expression to trim blanks from both ends of this string.
TextExpression	trim(char t)	Create expression to trim character from both ends of this string.
TextExpression	trim(CriteriaBuilder.Trimspec ts)	Create expression to trim blanks from this string.
TextExpression	trim(CriteriaBuilder.Trimspec ts, char t)	Create expression to trim character from this string.
TextExpression	trim(CriteriaBuilder.Trimspec ts, Expression<Character> t)	Create expression to trim character from this string.
TextExpression	trim(Expression<Character> t)	Create expression to trim character from both ends of this string.
TextExpression	upper()	Create expression for converting this string to uppercase.

Methods inherited from interface ComparableExpression

asc, asc, between, between, desc, desc, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, max, min

Methods inherited from interface Expression

as, cast, count, countDistinct, equalTo, equalTo, in, in, in, in, in, isMember, isNotMember, isNotNull, isNull, notEqualTo, notEqualTo, selectCase

Methods inherited from interface Selection

alias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from interface TupleElement

getAlias, getJavaType

Method Details

like

@Nonnull
Predicate like(@Nonnull
 Expression<String> pattern)

Create a predicate for testing whether this expression satisfies the given pattern.

Parameters:

pattern - string expression

Returns:

like predicate

See Also:

• CriteriaBuilder.like(Expression, Expression)

like

@Nonnull
Predicate like(@Nonnull
 String pattern)

Create a predicate for testing whether this expression satisfies the given pattern.

Parameters:

pattern - string

Returns:

like predicate

See Also:

• CriteriaBuilder.like(Expression, String)

like

@Nonnull
Predicate like(@Nonnull
 Expression<String> pattern,
 @Nonnull
 Expression<Character> escapeChar)

Create a predicate for testing whether this expression satisfies the given pattern.

Parameters:

pattern - string expression

escapeChar - escape character expression

Returns:

like predicate

See Also:

• CriteriaBuilder.like(Expression, Expression, Expression)

like

@Nonnull
Predicate like(@Nonnull
 Expression<String> pattern,
 char escapeChar)

Create a predicate for testing whether this expression satisfies the given pattern.

Parameters:

pattern - string expression

escapeChar - escape character

Returns:

like predicate

See Also:

• CriteriaBuilder.like(Expression, Expression, char)

like

@Nonnull
Predicate like(@Nonnull
 String pattern,
 @Nonnull
 Expression<Character> escapeChar)

Create a predicate for testing whether this expression satisfies the given pattern.

Parameters:

pattern - string

escapeChar - escape character expression

Returns:

like predicate

See Also:

• CriteriaBuilder.like(Expression, String, Expression)

like

@Nonnull
Predicate like(@Nonnull
 String pattern,
 char escapeChar)

Create a predicate for testing whether this expression satisfies the given pattern.

Parameters:

pattern - string

escapeChar - escape character

Returns:

like predicate

See Also:

• CriteriaBuilder.like(Expression, String, char)

notLike

@Nonnull
Predicate notLike(@Nonnull
 Expression<String> pattern)

Create a predicate for testing whether this expression does not satisfy the given pattern.

Parameters:

pattern - string expression

Returns:

not-like predicate

See Also:

• CriteriaBuilder.notLike(Expression, Expression)

notLike

@Nonnull
Predicate notLike(@Nonnull
 String pattern)

Create a predicate for testing whether this expression does not satisfy the given pattern.

Parameters:

pattern - string

Returns:

not-like predicate

See Also:

• CriteriaBuilder.notLike(Expression, String)

notLike

@Nonnull
Predicate notLike(@Nonnull
 Expression<String> pattern,
 @Nonnull
 Expression<Character> escapeChar)

Create a predicate for testing whether this expression does not satisfy the given pattern.

Parameters:

pattern - string expression

escapeChar - escape character expression

Returns:

not-like predicate

See Also:

• CriteriaBuilder.notLike(Expression, Expression, Expression)

notLike

@Nonnull
Predicate notLike(@Nonnull
 Expression<String> pattern,
 char escapeChar)

Create a predicate for testing whether this expression does not satisfy the given pattern.

Parameters:

pattern - string expression

escapeChar - escape character

Returns:

not-like predicate

See Also:

• CriteriaBuilder.notLike(Expression, Expression, char)

notLike

@Nonnull
Predicate notLike(@Nonnull
 String pattern,
 @Nonnull
 Expression<Character> escapeChar)

Create a predicate for testing whether this expression does not satisfy the given pattern.

Parameters:

pattern - string

escapeChar - escape character expression

Returns:

not-like predicate

See Also:

• CriteriaBuilder.notLike(Expression, String, Expression)

notLike

@Nonnull
Predicate notLike(@Nonnull
 String pattern,
 char escapeChar)

Create a predicate for testing whether this expression does not satisfy the given pattern.

Parameters:

pattern - string

escapeChar - escape character

Returns:

not-like predicate

See Also:

• CriteriaBuilder.notLike(Expression, String, char)

contains

@Nonnull
Predicate contains(@Nonnull
 String substring)

Create a predicate for testing whether this expression contains the given substring.

Parameters:

substring - string

Returns:

contains predicate

notContains

@Nonnull
Predicate notContains(@Nonnull
 String substring)

Create a predicate for testing whether this expression does not contain the given substring.

Parameters:

substring - string

Returns:

not-contains predicate

startsWith

@Nonnull
Predicate startsWith(@Nonnull
 String prefix)

Create a predicate for testing whether this expression starts with the given prefix.

Parameters:

prefix - string

Returns:

starts-with predicate

notStartsWith

@Nonnull
Predicate notStartsWith(@Nonnull
 String prefix)

Create a predicate for testing whether this expression does not start with the given prefix.

Parameters:

prefix - string

Returns:

not-starts-with predicate

endsWith

@Nonnull
Predicate endsWith(@Nonnull
 String suffix)

Create a predicate for testing whether this expression ends with the given suffix.

Parameters:

suffix - string

Returns:

ends-with predicate

notEndsWith

@Nonnull
Predicate notEndsWith(@Nonnull
 String suffix)

Create a predicate for testing whether this expression does not end with the given suffix.

Parameters:

suffix - string

Returns:

not-ends-with predicate

append

@Nonnull
TextExpression append(@Nonnull
 Expression<String> y)

Create an expression for string concatenation.

Parameters:

y - string expression

Returns:

expression corresponding to concatenation

See Also:

• CriteriaBuilder.concat(Expression, Expression)

append

@Nonnull
TextExpression append(@Nonnull
 String y)

Create an expression for string concatenation.

Parameters:

y - string

Returns:

expression corresponding to concatenation

See Also:

• CriteriaBuilder.concat(Expression, String)

prepend

@Nonnull
TextExpression prepend(@Nonnull
 Expression<String> y)

Create an expression for string concatenation.

Parameters:

y - string expression

Returns:

expression corresponding to concatenation

See Also:

• CriteriaBuilder.concat(Expression, Expression)

prepend

@Nonnull
TextExpression prepend(@Nonnull
 String y)

Create an expression for string concatenation.

Parameters:

y - string

Returns:

expression corresponding to concatenation

See Also:

• CriteriaBuilder.concat(Expression, String)

substring

@Nonnull
TextExpression substring(@Nonnull
 Expression<Integer> from)

Create an expression for substring extraction. Extracts a substring starting at the specified position through to end of the string. First position is 1.

Parameters:

from - start position expression

Returns:

expression corresponding to substring extraction

See Also:

• CriteriaBuilder.substring(Expression, Expression)

substring

@Nonnull
TextExpression substring(int from)

Create an expression for substring extraction. Extracts a substring starting at the specified position through to end of the string. First position is 1.

Parameters:

from - start position

Returns:

expression corresponding to substring extraction

See Also:

• CriteriaBuilder.substring(Expression, int)

substring

@Nonnull
TextExpression substring(@Nonnull
 Expression<Integer> from,
 @Nonnull
 Expression<Integer> len)

Create an expression for substring extraction. Extracts a substring of given length starting at the specified position. First position is 1.

Parameters:

from - start position expression

len - length expression

Returns:

expression corresponding to substring extraction

See Also:

• CriteriaBuilder.substring(Expression, Expression, Expression)

substring

@Nonnull
TextExpression substring(int from,
 int len)

Create an expression for substring extraction. Extracts a substring of given length starting at the specified position. First position is 1.

Parameters:

from - start position

len - length

Returns:

expression corresponding to substring extraction

See Also:

• CriteriaBuilder.substring(Expression, int, int)

trim

@Nonnull
TextExpression trim()

Create expression to trim blanks from both ends of this string.

Returns:

trim expression

See Also:

• CriteriaBuilder.trim(Expression)

trim

@Nonnull
TextExpression trim(@Nonnull
 CriteriaBuilder.Trimspec ts)

Create expression to trim blanks from this string.

Parameters:

ts - trim specification

Returns:

trim expression

See Also:

• CriteriaBuilder.trim(CriteriaBuilder.Trimspec, Expression)

trim

@Nonnull
TextExpression trim(@Nonnull
 Expression<Character> t)

Create expression to trim character from both ends of this string.

Parameters:

t - expression for character to be trimmed

Returns:

trim expression

See Also:

• CriteriaBuilder.trim(Expression, Expression)

trim

@Nonnull
TextExpression trim(@Nonnull
 CriteriaBuilder.Trimspec ts,
 @Nonnull
 Expression<Character> t)

Create expression to trim character from this string.

Parameters:

ts - trim specification

t - expression for character to be trimmed

Returns:

trim expression

See Also:

• CriteriaBuilder.trim(CriteriaBuilder.Trimspec, Expression, Expression)

trim

@Nonnull
TextExpression trim(char t)

Create expression to trim character from both ends of this string.

Parameters:

t - character to be trimmed

Returns:

trim expression

See Also:

• CriteriaBuilder.trim(char, Expression)

trim

@Nonnull
TextExpression trim(@Nonnull
 CriteriaBuilder.Trimspec ts,
 char t)

Create expression to trim character from this string.

Parameters:

ts - trim specification

t - character to be trimmed

Returns:

trim expression

See Also:

• CriteriaBuilder.trim(CriteriaBuilder.Trimspec, char, Expression)

lower

@Nonnull
TextExpression lower()

Create expression for converting this string to lowercase.

Returns:

expression to convert to lowercase

See Also:

• CriteriaBuilder.lower(Expression)

upper

@Nonnull
TextExpression upper()

Create expression for converting this string to uppercase.

Returns:

expression to convert to uppercase

See Also:

• CriteriaBuilder.upper(Expression)

length

@Nonnull
Expression<Integer> length()

Create expression to return length of this string.

Returns:

length expression

See Also:

• CriteriaBuilder.length(Expression)

left

@Nonnull
TextExpression left(int len)

Create an expression for the leftmost substring of this string.

Parameters:

len - length of the substring to return

Returns:

expression for the leftmost substring

See Also:

• CriteriaBuilder.left(Expression, int)

right

@Nonnull
TextExpression right(int len)

Create an expression for the rightmost substring of this string.

Parameters:

len - length of the substring to return

Returns:

expression for the rightmost substring

See Also:

• CriteriaBuilder.right(Expression, int)

left

@Nonnull
TextExpression left(@Nonnull
 Expression<Integer> len)

Create an expression for the leftmost substring of this string.

Parameters:

len - length of the substring to return

Returns:

expression for the leftmost substring

See Also:

• CriteriaBuilder.left(Expression, Expression)

right

@Nonnull
TextExpression right(@Nonnull
 Expression<Integer> len)

Create an expression for the rightmost substring of this string.

Parameters:

len - length of the substring to return

Returns:

expression for the rightmost substring

See Also:

• CriteriaBuilder.right(Expression, Expression)

replace

@Nonnull
TextExpression replace(@Nonnull
 Expression<String> substring,
 @Nonnull
 Expression<String> replacement)

Create an expression replacing every occurrence of a substring within this string.

Parameters:

substring - the literal substring to replace

replacement - the replacement string

Returns:

expression for the resulting string

See Also:

• CriteriaBuilder.replace(Expression, Expression, Expression)

replace

@Nonnull
TextExpression replace(@Nonnull
 String substring,
 @Nonnull
 Expression<String> replacement)

Create an expression replacing every occurrence of a substring within this string.

Parameters:

substring - the literal substring to replace

replacement - the replacement string

Returns:

expression for the resulting string

See Also:

• CriteriaBuilder.replace(Expression, String, Expression)

replace

@Nonnull
TextExpression replace(@Nonnull
 Expression<String> substring,
 @Nonnull
 String replacement)

Create an expression replacing every occurrence of a substring within this string.

Parameters:

substring - the literal substring to replace

replacement - the replacement string

Returns:

expression for the resulting string

See Also:

• CriteriaBuilder.replace(Expression, Expression, String)

replace

@Nonnull
TextExpression replace(@Nonnull
 String substring,
 @Nonnull
 String replacement)

Create an expression replacing every occurrence of a substring within this string.

Parameters:

substring - the literal substring to replace

replacement - the replacement string

Returns:

expression for the resulting string

See Also:

• CriteriaBuilder.replace(Expression, String, String)

locate

@Nonnull
NumericExpression<Integer> locate(@Nonnull
 Expression<String> pattern)

Create expression to locate the position of one string within this, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.

Warning: the order of the parameters of this method is reversed compared to the corresponding function in JPQL.

Parameters:

pattern - expression for string to be located

Returns:

expression corresponding to position

See Also:

• CriteriaBuilder.locate(Expression, Expression)

locate

@Nonnull
NumericExpression<Integer> locate(@Nonnull
 String pattern)

Create expression to locate the position of one string within this, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.

Warning: the order of the parameters of this method is reversed compared to the corresponding function in JPQL.

Parameters:

pattern - string to be located

Returns:

expression corresponding to position

See Also:

• CriteriaBuilder.locate(Expression, String)

locate

@Nonnull
NumericExpression<Integer> locate(@Nonnull
 Expression<String> pattern,
 @Nonnull
 Expression<Integer> from)

Create expression to locate the position of one string within this, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.

Warning: the order of the first two parameters of this method is reversed compared to the corresponding function in JPQL.

Parameters:

pattern - expression for string to be located

from - expression for position at which to start search

Returns:

expression corresponding to position

See Also:

• CriteriaBuilder.locate(Expression, Expression, Expression)

locate

@Nonnull
NumericExpression<Integer> locate(@Nonnull
 String pattern,
 int from)

Create expression to locate the position of one string within this, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.

Warning: the order of the first two parameters of this method is reversed compared to the corresponding function in JPQL.

Parameters:

pattern - string to be located

from - position at which to start search

Returns:

expression corresponding to position

See Also:

• CriteriaBuilder.locate(Expression, String, int)

coalesce

@Nonnull
TextExpression coalesce(String y)

Description copied from interface: Expression

Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.

Specified by:

coalesce in interface ComparableExpression<String>

Specified by:

coalesce in interface Expression<String>

Parameters:

y - value

Returns:

coalesce expression

coalesce

@Nonnull
TextExpression coalesce(@Nonnull
 Expression<? extends String> y)

Description copied from interface: Expression

Create an expression that returns null if this and the argument evaluate to null, and the value of the first non-null expression otherwise.

Specified by:

coalesce in interface ComparableExpression<String>

Specified by:

coalesce in interface Expression<String>

Parameters:

y - expression

Returns:

coalesce expression

nullif

@Nonnull
TextExpression nullif(String y)

Description copied from interface: Expression

Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.

Specified by:

nullif in interface ComparableExpression<String>

Specified by:

nullif in interface Expression<String>

Parameters:

y - value

Returns:

nullif expression

nullif

@Nonnull
TextExpression nullif(@Nonnull
 Expression<? extends String> y)

Description copied from interface: Expression

Create an expression that tests whether this expression is equal to the argument, returning null if they are and the value of the first expression if they are not.

Specified by:

nullif in interface ComparableExpression<String>

Specified by:

nullif in interface Expression<String>

Parameters:

y - expression

Returns:

nullif expression