com.vladsch.kotlin.jdbc.Model.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-jdbc Show documentation
A thin library that exposes JDBC API with the convenience of Kotlin and gets out of the way when not needed.
The newest version!
package com.vladsch.kotlin.jdbc

import javax.json.JsonArray
import javax.json.JsonObject
import kotlin.reflect.KProperty

@Suppress("MemberVisibilityCanBePrivate", "UNCHECKED_CAST", "PropertyName")
abstract class Model, D>(session: Session?, sqlTable: String, dbCase: Boolean, allowSetAuto: Boolean = true, quote: String? = null) {
    internal val _db = ModelProperties>(session ?: session(), sqlTable, dbCase, allowSetAuto, quote)
    protected val db: ModelPropertyProvider> get() = _db

    fun load(rs: Row): M {
        _db.load(rs)
        return this as M
    }

    fun load(json: JsonObject): M {
        _db.load(json)
        return this as M
    }

    fun load(other: Model<*, *>): M {
        _db.load(other)
        return this as M
    }

    val _session: Session get() = _db.session
    val _quote: String get() = _db.quote

    fun toJson() = _db.toJsonObject()

    val insertQuery: SqlQuery get() = _db.sqlInsertQuery()
    val deleteQuery: SqlQuery get() = _db.sqlDeleteQuery()
    val updateQuery: SqlQuery get() = _db.sqlUpdateQuery()
    val selectQuery: SqlQuery get() = _db.sqlSelectQuery()
    val selectSql: String get() = _db.sqlSelectTable()

    fun Appendable.appendQuoted(id: kotlin.String): Appendable {
        return _db.appendQuoted(this, id)
    }

    fun Appendable.appendSqlSelectTable(): Appendable {
        return _db.appendSelectSql(this)
    }

    fun insert() = _db.insert()
    fun insertIgnoreKeys() = _db.insertIgnoreKeys()
    fun select() = _db.select()
    fun insertReload() = _db.insertReload()
    fun clearAutoKeys() = _db.clearAutoKeys()
    fun delete() = _db.delete()
    fun update() = _db.update()
    fun updateReload() = _db.updateReload()
    fun deleteKeepAutoKeys() = _db.deleteKeepAutoKeys()
    fun snapshot() = _db.snapshot()
    fun isDirty(): Boolean = _db.isModified()
    fun isDirty(property: KProperty<*>): Boolean = _db.isModified(property)
    fun appendKeys(appendable: Appendable, params: ArrayList, delimiter: String = " AND ", sep: String = ""): String =
            _db.appendKeys(appendable, params, delimiter, sep, null)

    fun forEachKey(consumer: (prop: KProperty<*>, propType: PropertyType, value: Any?) -> Unit) = _db.forEachKey(consumer)

    fun forEachProp(consumer: (prop: KProperty<*>, propType: PropertyType, value: Any?) -> Unit) = _db.forEachProp(consumer)

    fun forEachKey(consumer: (prop: KProperty<*>, propType: PropertyType, columnName: String, value: Any?) -> Unit) =
            _db.forEachKey(consumer)

    fun forEachProp(consumer: (prop: KProperty<*>, propType: PropertyType, columnName: String, value: Any?) -> Unit) =
            _db.forEachProp(consumer)

    /**
     * set property value directly in the _model property map, by passing _model properties
     *
     * Can be used to set non-writable properties
     */
    protected fun  setProperty(prop: KProperty<*>, value: V) {
        @Suppress("UNCHECKED_CAST")
        _db.setProperty(this, prop, value)
    }

    fun quoteIdentifier(id: String): String = _db.appendQuoted(StringBuilder(), id).toString()

    fun appendSelectSql(out: Appendable, alias: String? = null): Appendable = _db.appendSelectSql(out, alias)

    fun appendListQuery(out: Appendable, params: Array>, alias: String? = null): Appendable = _db.appendListQuery(out, params, alias)

    fun appendListQuery(out: Appendable, params: Map, alias: String? = null): Appendable = _db.appendListQuery(out, params, alias)

    fun listQuery(params: Map, alias: String? = null): SqlQuery = _db.listQuery(params, alias)

    fun listQuery(vararg params: Pair, alias: String? = null): SqlQuery = _db.listQuery(params, alias)

    fun listQuery(whereClause: String, params: Map, alias: String? = null): SqlQuery = _db.listQuery(whereClause, params, alias)

    fun listData(): List = _db.listData(toData)

    fun listData(whereClause: String): List = _db.listData(whereClause, toData)

    fun listData(sqlQuery: SqlQuery): List = _db.session.list(sqlQuery, toData)

    fun listData(params: Map, alias: String? = null): List = _db.session.list(listQuery(params, alias), toData)

    fun listData(whereClause: String, params: Map, alias: String? = null): List = _db.session.list(listQuery(whereClause, params, alias), toData)

    fun jsonArray(): JsonArray = _db.session.jsonArray(listQuery(), toJsonObject)

    fun jsonArray(whereClause: String): JsonArray = _db.session.jsonArray(listQuery(whereClause, mapOf()), toJsonObject)

    fun jsonArray(sqlQuery: SqlQuery): JsonArray = _db.session.jsonArray(sqlQuery, toJsonObject)

    fun jsonArray(params: Map, alias: String? = null): JsonArray = _db.session.jsonArray(listQuery(params, alias), toJsonObject)

    fun jsonArray(whereClause: String, params: Map, alias: String? = null): JsonArray = _db.session.jsonArray(listQuery(whereClause, params, alias), toJsonObject)

    fun listModel(): List = _db.listModel(toModel) as List

    fun listModel(whereClause: String): List = _db.listModel(whereClause, toModel) as List

    fun listModel(sqlQuery: SqlQuery): List = _db.session.list(sqlQuery, toModel)

    fun listModel(params: Map, alias: String? = null): List = _db.session.list(listQuery(params, alias), toModel)

    fun listModel(whereClause: String, params: Map, alias: String? = null): List = _db.session.list(listQuery(whereClause, params, alias), toModel)

    // create a new copy, same params
    abstract operator fun invoke(): M

    // create a data of this
    abstract fun toData(): D

    // instance in this model used to load lists
    private val loader: M by lazy { invoke() }

    val toData: (Row) -> D = {
        loader.load(it).toData()
    }

    val toModel: (Row) -> M = {
        loader.load(it)
    }

    override fun toString(): String {
        val sb = StringBuilder()
        var sep = ""
        sb.append(_db.tableName).append("(")
        forEachProp { prop, propType, value ->
            if (value !== Unit) {
                sb.append(sep)
                if (propType.isKey) sb.append('*')
                sb.append(prop.name).append("=").append(value)
                sep = ", "
            }
        }
        sb.append(")")
        return sb.toString()
    }
}