/**
* Copyright 2010 Wallace Wadge
*
* 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.jolbox.bonecp;
/**
* Interface to the JDBC statement cache.
*
* @author wallacew
*/
public interface IStatementCache {
/**
* Retrieves the cached statement identified by the given key
*
* @param sql SQL statement
* @return Statement, or null if not found.
*/
StatementHandle get(String sql);
/**
* Returns size of the cache.
*
* @return cache size
*/
int size();
/**
* Clears the cache
*
*/
void clear();
/**
* Retrieves the cached statement identified by the given key
*
* @param sql SQL Statement
* @param resultSetType a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return Statement, or null if not found.
*/
StatementHandle get(String sql, int resultSetType,
int resultSetConcurrency, int resultSetHoldability);
/**
* Retrieves the cached statement identified by the given key
*
* @param sql SQL Statement
* @param resultSetType a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
* @return Statement, or null if not found.
*/
StatementHandle get(String sql, int resultSetType,
int resultSetConcurrency);
/**
* Retrieves the cached statement identified by the given key
*
* @param sql SQL Statement
* @param autoGeneratedKeys a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
* @return Statement, or null if not found.
*/
StatementHandle get(String sql, int autoGeneratedKeys);
/**
* Retrieves the cached statement identified by the given key
*
* @param sql SQL Statement
* @param columnIndexes an array of column indexes indicating the columns that should be returned from the inserted row or rows
* @return Statement, or null if not found.
*/
StatementHandle get(String sql, int[] columnIndexes);
/**
* Retrieves the cached statement identified by the given key
*
* @param sql SQL Statement
* @param columnNames an array of column names indicating the columns that should be returned from the inserted row or rows
* @return Statement, or null if not found.
*/
StatementHandle get(String sql, String[] columnNames);
/** Calculates a cache key.
* @param sql SQL Statement
* @param columnNames an array of column names indicating the columns that should be returned from the inserted row or rows
* @return cache key
*/
String calculateCacheKey(String sql, String[] columnNames);
/** Returns a cache key.
* @param sql SQL Statement
* @param columnIndexes an array of column indexes indicating the columns that should be returned from the inserted row or rows
* @return cache key
*/
String calculateCacheKey(String sql, int[] columnIndexes);
/** Returns a cache key.
* @param sql SQL Statement
* @param autoGeneratedKeys
* @return cache key.
*/
String calculateCacheKey(String sql, int autoGeneratedKeys);
/** Returns a cache key.
* @param sql SQL Statement
* @param resultSetType a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
* @return cache key.
*/
String calculateCacheKey(String sql, int resultSetType,
int resultSetConcurrency);
/** Returns a cache key.
* @param sql SQL Statement
* @param resultSetType a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return cache key.
*/
String calculateCacheKey(String sql, int resultSetType,
int resultSetConcurrency, int resultSetHoldability);
/**
* Checks that the entries in the cache have been properly closed when the connection dies down.
*/
void checkForProperClosure();
/**
* Wrapper for map putIfAbsent.
* @param cacheKey
* @param statementHandle
*/
void putIfAbsent(String cacheKey, StatementHandle statementHandle);
}