com.jolbox.bonecp
Interface IStatementCache

All Known Implementing Classes:

StatementCache

public interface IStatementCache

Interface to the JDBC statement cache.

Author:

wallacew

Method Summary

String	calculateCacheKey(String sql, int autoGeneratedKeys) Returns a cache key.
String	calculateCacheKey(String sql, int[] columnIndexes) Returns a cache key.
String	calculateCacheKey(String sql, int resultSetType, int resultSetConcurrency) Returns a cache key.
String	calculateCacheKey(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Returns a cache key.
String	calculateCacheKey(String sql, String[] columnNames) Calculates a cache key.
void	checkForProperClosure() Checks that the entries in the cache have been properly closed when the connection dies down.
void	clear() Clears the cache
StatementHandle	get(String sql) Retrieves the cached statement identified by the given key
StatementHandle	get(String sql, int autoGeneratedKeys) Retrieves the cached statement identified by the given key
StatementHandle	get(String sql, int[] columnIndexes) Retrieves the cached statement identified by the given key
StatementHandle	get(String sql, int resultSetType, int resultSetConcurrency) Retrieves the cached statement identified by the given key
StatementHandle	get(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Retrieves the cached statement identified by the given key
StatementHandle	get(String sql, String[] columnNames) Retrieves the cached statement identified by the given key
void	putIfAbsent(String cacheKey, StatementHandle statementHandle) Wrapper for map putIfAbsent.
int	size() Returns size of the cache.

Method Detail

get

StatementHandle get(String sql)

Retrieves the cached statement identified by the given key

Parameters:

sql - SQL statement

Returns:

Statement, or null if not found.

size

int size()

Returns size of the cache.

Returns:

cache size

clear

void clear()

Clears the cache

get

StatementHandle get(String sql,
                    int resultSetType,
                    int resultSetConcurrency,
                    int resultSetHoldability)

Retrieves the cached statement identified by the given key

Parameters:

sql - SQL Statement

resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

Statement, or null if not found.

get

StatementHandle get(String sql,
                    int resultSetType,
                    int resultSetConcurrency)

Retrieves the cached statement identified by the given key

Parameters:

sql - SQL Statement

resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

Returns:

Statement, or null if not found.

get

StatementHandle get(String sql,
                    int autoGeneratedKeys)

Retrieves the cached statement identified by the given key

Parameters:

sql - SQL Statement

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Returns:

Statement, or null if not found.

get

StatementHandle get(String sql,
                    int[] columnIndexes)

Retrieves the cached statement identified by the given key

Parameters:

sql - SQL Statement

columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows

Returns:

Statement, or null if not found.

get

StatementHandle get(String sql,
                    String[] columnNames)

Retrieves the cached statement identified by the given key

Parameters:

sql - SQL Statement

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

Returns:

Statement, or null if not found.

calculateCacheKey

String calculateCacheKey(String sql,
                         String[] columnNames)

Calculates a cache key.

Parameters:

sql - SQL Statement

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

Returns:

cache key

calculateCacheKey

String calculateCacheKey(String sql,
                         int[] columnIndexes)

Returns a cache key.

Parameters:

sql - SQL Statement

columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows

Returns:

cache key

calculateCacheKey

String calculateCacheKey(String sql,
                         int autoGeneratedKeys)

Returns a cache key.

Parameters:

sql - SQL Statement

autoGeneratedKeys -

Returns:

cache key.

calculateCacheKey

String calculateCacheKey(String sql,
                         int resultSetType,
                         int resultSetConcurrency)

Returns a cache key.

Parameters:

sql - SQL Statement

resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

Returns:

cache key.

calculateCacheKey

String calculateCacheKey(String sql,
                         int resultSetType,
                         int resultSetConcurrency,
                         int resultSetHoldability)

Returns a cache key.

Parameters:

sql - SQL Statement

resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

cache key.

checkForProperClosure

void checkForProperClosure()

Checks that the entries in the cache have been properly closed when the connection dies down.

putIfAbsent

void putIfAbsent(String cacheKey,
                 StatementHandle statementHandle)

Wrapper for map putIfAbsent.

Parameters:

cacheKey -

statementHandle -