org.babyfish.jimmer.sql.kt.KTransientResolver.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jimmer-sql-kotlin Show documentation

A revolutionary ORM framework for both java and kotlin

There is a newer version: 0.9.35

package org.babyfish.jimmer.sql.kt

import org.babyfish.jimmer.lang.Ref
import org.babyfish.jimmer.sql.TransientResolver
import org.babyfish.jimmer.sql.loader.AbstractDataLoader
import java.sql.Connection
import java.util.*

interface KTransientResolver : TransientResolver {

    /**
     * @param ids A batch of ids of the current objects that are resolving calculated property,
     *            it is not empty
     * @return A map contains resolved values
     */
    override fun resolve(ids: Collection): Map

    /**
     * Please ignore this method if the current calculated property
     * returns nullable type or LIST of entity objects
     *
     * @return The default value, null will be ignored by jimmer.
     */
    override fun getDefaultValue(): V? = null

    /**
     * Please ignore this method if cache for current calculated property is not enabled.
     *
     * @return The reference wrapper of parameterMap
     * 
     *      If the `Ref` wrapper itself is null, it means there is some filter but not cacheable filter
     *      If the `Ref` wrapper itself is not null,
     *      it means there is no filter(wrapped value is null) or
     *      there is a cacheable filter(wrapped value is not null)
     * 
     */
    override fun getParameterMapRef(): Ref?>? =
        Ref.empty()

    companion object {

        /**
         * The database connection should be used,
         *  it can be ignored if the current resolver is injected by spring
         *  and the spring-transaction is enabled.
         * @return
         */
        @JvmStatic
        val currentConnection: Connection
            get() = TransientResolver.currentConnection()
    }
}