org.babyfish.jimmer.sql.TransientResolver Maven / Gradle / Ivy

Go to download

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

A revolutionary ORM framework for both java and kotlin

There is a newer version: 0.9.19

package org.babyfish.jimmer.sql;

import org.babyfish.jimmer.lang.Ref;
import org.babyfish.jimmer.sql.cache.PropCacheInvalidator;
import org.babyfish.jimmer.sql.loader.AbstractDataLoader;
import org.babyfish.jimmer.sql.loader.TransientResolverContext;
import org.jetbrains.annotations.NotNull;

import java.sql.Connection;
import java.util.Collection;
import java.util.Map;
import java.util.SortedMap;

/**
 * Only for java, kotlin developers should use `KTransientResolver`
 *
 * @param 
 * @param 
 */
public interface TransientResolver extends PropCacheInvalidator {

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

    /**
     * Please ignore this method if the current calculated property
     * returns nullable type or LIST of entity objects
     * @return Then default value, null will be ignored by jimmer.
     */
    default V getDefaultValue() {
        return 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)
     * 
     */
    default Ref> getParameterMapRef() {
        return Ref.empty();
    }

    /**
     * Get 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 the database connection should be used, never return null.
     * @exception IllegalStateException cannot retrieve the current connection.
     */
    @NotNull
    static Connection currentConnection() {
        TransientResolverContext ctx = TransientResolverContext.peek();
        if (ctx == null) {
            throw new IllegalStateException("The current thread is not resolving transient resolver");
        }
        return ctx.getConnection();
    }
}