org.seasar.doma.expr

Interface ExpressionFunctions

All Known Implementing Classes:

Db2Dialect.Db2ExpressionFunctions, H212126Dialect.H212126ExpressionFunctions, H214199Dialect.H214199ExpressionFunctions, H2Dialect.H2ExpressionFunctions, HsqldbDialect.HsqldbExpressionFunctions, Mssql2008Dialect.Mssql2008ExpressionFunctions, MssqlDialect.MssqlExpressionFunctions, MysqlDialect.MysqlExpressionFunctions, Oracle11Dialect.Oracle11ExpressionFunctions, OracleDialect.OracleExpressionFunctions, PostgresDialect.PostgresExpressionFunctions, SqliteDialect.SqliteExpressionFunctions, StandardDialect.StandardExpressionFunctions

public interface ExpressionFunctions

The aggregation of functions that are available in expressions in SQL templates.

Method Summary

Modifier and Type	Method and Description
java.lang.String	escape(java.lang.CharSequence text) Escapes the SQL LIKE wild card characters in a target string by using the default escape character.
java.lang.String	escape(java.lang.CharSequence text, char escapeChar) Escapes the SQL LIKE wild card characters in a target string by using a specified escape character.
java.lang.String	infix(java.lang.CharSequence infix) Escapes the SQL LIKE wild card characters in a target string by using the default escape character '$' and generate a text to perform a infix search for the SQL LIKE operator.
java.lang.String	infix(java.lang.CharSequence infix, char escapeChar) Escapes the SQL LIKE wild card characters in a target string by using a specified escape character and generate a text to perform a infix search for the SQL LIKE operator.
boolean	isBlank(java.lang.CharSequence text) Whether a text is blank.
boolean	isEmpty(java.lang.CharSequence text) Whether a text is empty.
boolean	isNotBlank(java.lang.CharSequence text) Whether a text is not blank.
boolean	isNotEmpty(java.lang.CharSequence text) Whether a text is not empty.
java.lang.String	prefix(java.lang.CharSequence prefix) Escapes the SQL LIKE wild card characters in a target string by using the default escape character '$' and generate a text to perform a prefix search for the SQL Like operator.
java.lang.String	prefix(java.lang.CharSequence prefix, char escapeChar) Escapes the SQL LIKE wild card characters in a target string by using a specified escape character and generate a text to perform a prefix search for the SQL LIKE operator.
java.util.Date	roundDownTimePart(java.util.Date date) Round down a time part of Date.
java.sql.Date	roundDownTimePart(java.sql.Date date) Round down a time part of Date.
java.time.LocalDateTime	roundDownTimePart(java.time.LocalDateTime localDateTime) Round down a time part of LocalDateTime.
java.sql.Timestamp	roundDownTimePart(java.sql.Timestamp timestamp) Round down a time part of Timestamp.
java.util.Date	roundUpTimePart(java.util.Date date) Round up a time part of Date.
java.sql.Date	roundUpTimePart(java.sql.Date date) Round up a time part of Date.
java.time.LocalDate	roundUpTimePart(java.time.LocalDate localDate) Return the next day.
java.time.LocalDateTime	roundUpTimePart(java.time.LocalDateTime localDateTime) Round up a time part of LocalDateTime.
java.sql.Timestamp	roundUpTimePart(java.sql.Timestamp timestamp) Round up a time part of Timestamp.
java.lang.String	suffix(java.lang.CharSequence suffix) Escapes the SQL LIKE wild card characters in a target string by using the default escape character '$' and generate a text to perform a suffix search for the SQL LIKE operator.
java.lang.String	suffix(java.lang.CharSequence suffix, char escapeChar) Escapes the SQL LIKE wild card characters in a target string by using a specified escape character and generate a text to perform a suffix search for the SQL LIKE operator.

Method Detail

escape

java.lang.String escape(java.lang.CharSequence text)

Escapes the SQL LIKE wild card characters in a target string by using the default escape character.

For example, a%b_ is converted to the a a$%b$_.

Parameters:

text - the target text

Returns:

the escaped text

escape

java.lang.String escape(java.lang.CharSequence text,
                        char escapeChar)

Escapes the SQL LIKE wild card characters in a target string by using a specified escape character.

Parameters:

text - the target text

escapeChar - the escape character

Returns:

the escaped text

prefix

java.lang.String prefix(java.lang.CharSequence prefix)

Escapes the SQL LIKE wild card characters in a target string by using the default escape character '$' and generate a text to perform a prefix search for the SQL Like operator.

For example, a%b_ is converted to the a a$%b$_%.

Parameters:

prefix - the prefix text

Returns:

the text for a prefix search

prefix

java.lang.String prefix(java.lang.CharSequence prefix,
                        char escapeChar)

Escapes the SQL LIKE wild card characters in a target string by using a specified escape character and generate a text to perform a prefix search for the SQL LIKE operator.

Parameters:

prefix - the prefixed text

escapeChar - the escape character

Returns:

the text for a prefix search

suffix

java.lang.String suffix(java.lang.CharSequence suffix)

Escapes the SQL LIKE wild card characters in a target string by using the default escape character '$' and generate a text to perform a suffix search for the SQL LIKE operator.

For example, a%b_ is converted to the a %a$%b$_.

Parameters:

suffix - the suffix text

Returns:

the text for a suffix search

suffix

java.lang.String suffix(java.lang.CharSequence suffix,
                        char escapeChar)

Escapes the SQL LIKE wild card characters in a target string by using a specified escape character and generate a text to perform a suffix search for the SQL LIKE operator.

Parameters:

suffix - the suffix text

escapeChar - the escape character

Returns:

the text for a suffix search

infix

java.lang.String infix(java.lang.CharSequence infix)

Escapes the SQL LIKE wild card characters in a target string by using the default escape character '$' and generate a text to perform a infix search for the SQL LIKE operator.

For example, a%b_ is converted to the a %a$%b$_%.

Parameters:

infix - the infix text

Returns:

the text for a infix search

infix

java.lang.String infix(java.lang.CharSequence infix,
                       char escapeChar)

Escapes the SQL LIKE wild card characters in a target string by using a specified escape character and generate a text to perform a infix search for the SQL LIKE operator.

Parameters:

infix - the infix text

escapeChar - the escape character

Returns:

the text for a infix search

roundDownTimePart

java.util.Date roundDownTimePart(java.util.Date date)

Round down a time part of Date.

Parameters:

date - the target date

Returns:

the date whose time part is rounded down

roundDownTimePart

java.sql.Date roundDownTimePart(java.sql.Date date)

Round down a time part of Date.

Parameters:

date - the target date

Returns:

the date whose time part is rounded down

roundDownTimePart

java.sql.Timestamp roundDownTimePart(java.sql.Timestamp timestamp)

Round down a time part of Timestamp.

Parameters:

timestamp - the target timestamp

Returns:

the timestamp whose time part is rounded down

roundDownTimePart

java.time.LocalDateTime roundDownTimePart(java.time.LocalDateTime localDateTime)

Round down a time part of LocalDateTime.

Parameters:

localDateTime - the target localDateTime

Returns:

the localDateTime whose time part is rounded down

roundUpTimePart

java.util.Date roundUpTimePart(java.util.Date date)

Round up a time part of Date.

Parameters:

date - the target date

Returns:

the date whose time part is rounded up

roundUpTimePart

java.sql.Date roundUpTimePart(java.sql.Date date)

Round up a time part of Date.

Parameters:

date - the target date

Returns:

the date whose time part is rounded up

roundUpTimePart

java.sql.Timestamp roundUpTimePart(java.sql.Timestamp timestamp)

Round up a time part of Timestamp.

Parameters:

timestamp - the target timestamp

Returns:

the timestamp whose time part is rounded up

roundUpTimePart

java.time.LocalDate roundUpTimePart(java.time.LocalDate localDate)

Return the next day.

Parameters:

localDate - the target localDate

Returns:

the next day

roundUpTimePart

java.time.LocalDateTime roundUpTimePart(java.time.LocalDateTime localDateTime)

Round up a time part of LocalDateTime.

Parameters:

localDateTime - the target localDateTime

Returns:

the localDateTime whose time part is rounded up

isEmpty

boolean isEmpty(java.lang.CharSequence text)

Whether a text is empty.

Parameters:

text - the target text

Returns:

true if the text is null or its length is 0, else false

isNotEmpty

boolean isNotEmpty(java.lang.CharSequence text)

Whether a text is not empty.

Parameters:

text - the target text

Returns:

false if the text is null or its length is 0, else true

isBlank

boolean isBlank(java.lang.CharSequence text)

Whether a text is blank.

Parameters:

text - the target text

Returns:

true if the text is null, its length is 0 or the text contains only blank characters, else false.

isNotBlank

boolean isNotBlank(java.lang.CharSequence text)

Whether a text is not blank.

Parameters:

text - the target text

Returns:

false if the text is null, its length is 0 or the text contains only blank characters, else true.