com.landawn.abacus.cache.QueryCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-entity-manager Show documentation
Abacus Entity Manager
The newest version!
/*
 * Copyright (C) 2015 HaiYang Li
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.landawn.abacus.cache;

import java.util.Collection;
import java.util.Map;

import com.landawn.abacus.core.SQLResult;
import com.landawn.abacus.core.command.Command;
import com.landawn.abacus.pool.Poolable;
import com.landawn.abacus.util.Options.Cache;

// TODO: Auto-generated Javadoc
/**
 *
 * @author Haiyang Li
 * @since 0.8
 */
public interface QueryCache extends Poolable {
    /**
     * Method lock.
     */
    void lock();

    /**
     * Method unLock.
     */
    void unlock();

    /**
     *
     * @param propName
     * @return int
     */
    int getPropIndex(String propName);

    /**
     *
     * @param queryResult
     * @param cachePropNames
     * @param cond
     * @param range
     */
    void cacheResult(SQLResult queryResult, Collection cachePropNames, Cache.Condition cond, Cache.Range range);

    /**
     *
     * @param queryResult
     * @param cachePropNames
     * @param cacheCond
     * @param range
     * @param closeResult
     */
    void asyncCacheResult(final SQLResult queryResult, final Collection cachePropNames, final Cache.Condition cacheCond, final Cache.Range range,
            final boolean closeResult);

    /**
     *
     * @param command
     * @param options
     * @return boolean
     */
    boolean update(Command command, Map options);

    /**
     * 
     * @return Collection
     */
    Collection getCachedPropNames();

    /**
     *
     * @param propName
     * @param range
     * @return boolean
     */
    boolean isCachedResult(String propName, Cache.Range range);

    /**
     * 
     * @return DataGrid