exposed-core/org.jetbrains.exposed.sql/ColumnWithTransform

ColumnWithTransform

open class ColumnWithTransform<Unwrapped, Wrapped>(val delegate: IColumnType<Unwrapped & Any>, val transformer: ColumnTransformer<Unwrapped, Wrapped>) : ColumnType<Wrapped & Any>

A class that handles the transformation between a source column type and a target type.

ColumnWithTransform extends ColumnType and can be used to define columns.

It does not apply transformations to null values. null values are passed directly to the delegated column type. If you need to transform null values, use NullableColumnWithTransform instead.

Parameters

Wrapped

The type to which the column value of type Unwrapped is transformed

Unwrapped

The type of the column

delegate

The original column's IColumnType

transformer

Instance of ColumnTransformer that makes actual data transformation

Inheritors

NullableColumnWithTransform

Constructors

ColumnWithTransform

constructor(delegate: IColumnType<Unwrapped & Any>, transformer: ColumnTransformer<Unwrapped, Wrapped>)

Properties

delegate

val delegate: IColumnType<Unwrapped & Any>

isAutoInc

val IColumnType<*>.isAutoInc: Boolean

Returns true if this is an auto-increment column, false otherwise.

nullable

open override var nullable: Boolean

Returns true if the column type is nullable, false otherwise.

originalColumnType

val originalColumnType: IColumnType<Any>

Gets the original column type that this column with transformation wraps around.

transformer

val transformer: ColumnTransformer<Unwrapped, Wrapped>

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

nonNullValueAsDefaultString

open fun nonNullValueAsDefaultString(value: Wrapped & Any): String

Returns the String representation of the specified non-null value when value is set as the default for the column.

nonNullValueToString

open fun nonNullValueToString(value: Wrapped & Any): String

Returns the SQL representation of the specified non-null value, for this column type.

notNullValueToDB

open override fun notNullValueToDB(value: Wrapped & Any): Any

Returns an object compatible with the database, from the specified non-null value, for this column type.

parameterMarker

open fun parameterMarker(value: Wrapped?): String

Defines the appearance of parameter markers in prepared SQL statements.

readObject

open fun readObject(rs: ResultSet, index: Int): Any?

Returns the object at the specified index in the rs.

setParameter

open override fun setParameter(stmt: PreparedStatementApi, index: Int, value: Any?)

Sets the value at the specified index into the stmt.

sqlType

open override fun sqlType(): String

Returns the SQL type of this column.

toString

open override fun toString(): String

unwrapRecursive

open fun unwrapRecursive(value: Wrapped?): Any?

Recursively unwraps the given value by applying the delegate's transformation.

validateValueBeforeUpdate

open fun validateValueBeforeUpdate(value: Wrapped?)

Function checks that provided value is suites the column type and throws IllegalArgumentException otherwise. value can be of any type (including Expression)

valueAsDefaultString

open fun valueAsDefaultString(value: Wrapped?): String

Returns the String representation of the specified value when value is set as the default for the column. If the value is null and the column is not nullable, an exception will be thrown. Used for metadata default value comparison.

valueFromDB

open override fun valueFromDB(value: Any): Wrapped?

Converts the specified value (from the database) to an object of the appropriated type, for this column type. Default implementation returns the same instance.

valueToDB

open override fun valueToDB(value: Wrapped?): Any?

Returns an object compatible with the database, from the specified value, for this column type.

valueToString

open fun valueToString(value: Wrapped?): String

Returns the SQL representation of the specified value, for this column type. If the value is null and the column is not nullable, an exception will be thrown. Used when generating an SQL statement and when logging that statement.