ktorm-core/org.ktorm.expression/CaseWhenExpression

CaseWhenExpression

data class CaseWhenExpression<T : Any>(val operand: ScalarExpression<*>?, val whenClauses: List<Pair<ScalarExpression<*>, ScalarExpression<T>>>, val elseClause: ScalarExpression<T>?, val sqlType: SqlType<T>, val isLeafNode: Boolean = false, val extraProperties: Map<String, Any> = emptyMap()) : ScalarExpression<T> (source)

Case-when expression, represents a SQL case-when clause.

There are two kind of case-when clauses in SQL, one is simple case-when clause, which has an operand following the case keyword, for example:

case operand when a then 1 when b then 2 else 3

The other is searched case-when clause, which doesn't have an operand, for example:

case when a = 1 then 1 when b = 2 then 2 else 3

See the SQL BNF Grammar https://ronsavage.github.io/SQL/sql-2003-2.bnf.html#case%20expression

Since

3.6.0

Constructors

CaseWhenExpression

constructor(operand: ScalarExpression<*>?, whenClauses: List<Pair<ScalarExpression<*>, ScalarExpression<T>>>, elseClause: ScalarExpression<T>?, sqlType: SqlType<T>, isLeafNode: Boolean = false, extraProperties: Map<String, Any> = emptyMap())

Properties

elseClause

val elseClause: ScalarExpression<T>?

the result in case no when clauses are matched.

extraProperties

open override val extraProperties: Map<String, Any>

Extra properties of this expression, maybe useful in SqlFormatter to generate some special SQLs.

isLeafNode

open override val isLeafNode: Boolean = false

Check if this expression is a leaf node in expression trees.

operand

val operand: ScalarExpression<*>?

the case operand, might be null for simple case-when clauses.

sqlType

open override val sqlType: SqlType<T>

The SqlType of this column or expression.

whenClauses

val whenClauses: List<Pair<ScalarExpression<*>, ScalarExpression<T>>>

pairs of when clauses and their results.

Functions

aliased

open override fun aliased(label: String?): ColumnDeclaringExpression<T>

Wrap this instance as a ColumnDeclaringExpression.

and

infix fun ColumnDeclaring<Boolean>.and(value: Boolean): BinaryExpression<Boolean>

infix fun ColumnDeclaring<Boolean>.and(expr: ColumnDeclaring<Boolean>): BinaryExpression<Boolean>

And operator, translated to the and keyword in SQL.

asc

fun ColumnDeclaring<*>.asc(): OrderByExpression

Order this column or expression in ascending order.

asExpression

open override fun asExpression(): ScalarExpression<T>

Convert this instance to a ScalarExpression.

between

infix fun <T : Comparable<T>> ColumnDeclaring<T>.between(range: ClosedRange<T>): BetweenExpression

Between operator, translated to between .. and .. in SQL.

cast

fun <T : Any> ColumnDeclaring<*>.cast(sqlType: SqlType<T>): CastingExpression<T>

Cast the current column or expression to the given SqlType.

desc

fun ColumnDeclaring<*>.desc(): OrderByExpression

Order this column or expression in descending order, corresponding to the desc keyword in SQL.

div

infix operator fun <T : Number> ColumnDeclaring<T>.div(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.div(expr: ColumnDeclaring<T>): BinaryExpression<T>

Divide operator, translated to / in SQL.

infix fun <T : Any> ColumnDeclaring<T>.eq(value: T): BinaryExpression<Boolean>

infix fun <T : Any> ColumnDeclaring<T>.eq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Equal operator, translated to = in SQL.

greater

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greater(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greater(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater operator, translated to > in SQL.

greaterEq

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greaterEq(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.greaterEq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater-eq operator, translated to >= in SQL.

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gt(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gt(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater operator, translated to > in SQL.

gte

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gte(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.gte(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Greater-eq operator, translated to >= in SQL.

inList

infix fun ColumnDeclaring<*>.inList(query: Query): InListExpression

fun <T : Any> ColumnDeclaring<T>.inList(vararg list: T): InListExpression

infix fun <T : Any> ColumnDeclaring<T>.inList(list: Collection<T>): InListExpression

In-list operator, translated to the in keyword in SQL.

isNotNull

fun ColumnDeclaring<*>.isNotNull(): UnaryExpression<Boolean>

Check if the current column or expression is not null, translated to is not null in SQL.

isNull

fun ColumnDeclaring<*>.isNull(): UnaryExpression<Boolean>

Check if the current column or expression is null, translated to is null in SQL.

less

infix fun <T : Comparable<T>> ColumnDeclaring<T>.less(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.less(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less operator, translated to < in SQL.

lessEq

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lessEq(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lessEq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less-eq operator, translated to <= in SQL.

infix fun ColumnDeclaring<*>.like(value: String): BinaryExpression<Boolean>

infix fun ColumnDeclaring<*>.like(expr: ColumnDeclaring<String>): BinaryExpression<Boolean>

Like operator, translated to the like keyword in SQL.

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lt(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lt(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less operator, translated to < in SQL.

lte

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lte(value: T): BinaryExpression<Boolean>

infix fun <T : Comparable<T>> ColumnDeclaring<T>.lte(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Less-eq operator, translated to <= in SQL.

minus

infix operator fun <T : Number> ColumnDeclaring<T>.minus(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.minus(expr: ColumnDeclaring<T>): BinaryExpression<T>

Minus operator, translated to - in SQL.

neq

infix fun <T : Any> ColumnDeclaring<T>.neq(value: T): BinaryExpression<Boolean>

infix fun <T : Any> ColumnDeclaring<T>.neq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Not-equal operator, translated to <> in SQL.

not

operator fun ColumnDeclaring<Boolean>.not(): UnaryExpression<Boolean>

Negative operator, translated to the not keyword in SQL.

notBetween

infix fun <T : Comparable<T>> ColumnDeclaring<T>.notBetween(range: ClosedRange<T>): BetweenExpression

Not-between operator, translated to not between .. and .. in SQL.

notEq

infix fun <T : Any> ColumnDeclaring<T>.notEq(value: T): BinaryExpression<Boolean>

infix fun <T : Any> ColumnDeclaring<T>.notEq(expr: ColumnDeclaring<T>): BinaryExpression<Boolean>

Not-equal operator, translated to <> in SQL.

notInList

infix fun ColumnDeclaring<*>.notInList(query: Query): InListExpression

fun <T : Any> ColumnDeclaring<T>.notInList(vararg list: T): InListExpression

infix fun <T : Any> ColumnDeclaring<T>.notInList(list: Collection<T>): InListExpression

Not-in-list operator, translated to the not in keyword in SQL.

notLike

infix fun ColumnDeclaring<*>.notLike(value: String): BinaryExpression<Boolean>

infix fun ColumnDeclaring<*>.notLike(expr: ColumnDeclaring<String>): BinaryExpression<Boolean>

Not like operator, translated to the not like keyword in SQL.

infix fun ColumnDeclaring<Boolean>.or(value: Boolean): BinaryExpression<Boolean>

infix fun ColumnDeclaring<Boolean>.or(expr: ColumnDeclaring<Boolean>): BinaryExpression<Boolean>

Or operator, translated to the or keyword in SQL.

plus

infix operator fun <T : Number> ColumnDeclaring<T>.plus(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.plus(expr: ColumnDeclaring<T>): BinaryExpression<T>

Plus operator, translated to + in SQL.

rem

infix operator fun <T : Number> ColumnDeclaring<T>.rem(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.rem(expr: ColumnDeclaring<T>): BinaryExpression<T>

Mod operator, translated to % in SQL.

times

infix operator fun <T : Number> ColumnDeclaring<T>.times(value: T): BinaryExpression<T>

infix operator fun <T : Number> ColumnDeclaring<T>.times(expr: ColumnDeclaring<T>): BinaryExpression<T>

Multiply operator, translated to * in SQL.

toDouble

fun ColumnDeclaring<out Number>.toDouble(): CastingExpression<Double>

Cast the current column or expression's type to Double.

toFloat

fun ColumnDeclaring<out Number>.toFloat(): CastingExpression<Float>

Cast the current column or expression's type to Float.

toInt

@JvmName(name = "booleanToInt")

fun ColumnDeclaring<Boolean>.~~toInt~~(): CastingExpression<Int>

fun ColumnDeclaring<out Number>.toInt(): CastingExpression<Int>

Cast the current column or expression's type to Int.

toLong

fun ColumnDeclaring<out Number>.toLong(): CastingExpression<Long>

Cast the current column or expression's type to Long.

toShort

fun ColumnDeclaring<out Number>.toShort(): CastingExpression<Short>

Cast the current column or expression's type to Short.

unaryMinus

operator fun <T : Number> ColumnDeclaring<T>.unaryMinus(): UnaryExpression<T>

Unary minus operator, translated to - in SQL.

unaryPlus

operator fun <T : Number> ColumnDeclaring<T>.unaryPlus(): UnaryExpression<T>

Unary plus operator, translated to + in SQL.

wrapArgument

open override fun wrapArgument(argument: T?): ArgumentExpression<T>

Wrap the given argument as an ArgumentExpression using the sqlType.

xor

infix fun ColumnDeclaring<Boolean>.xor(value: Boolean): BinaryExpression<Boolean>

infix fun ColumnDeclaring<Boolean>.xor(expr: ColumnDeclaring<Boolean>): BinaryExpression<Boolean>

Xor operator, translated to the xor keyword in SQL.