org.vibur.dbcp.stcache

Interface StatementCache

All Known Implementing Classes:

ClhmStatementCache

public interface StatementCache

Defines the operations needed for the JDBC PreparedStatement caching.

Author:

Simeon Malchev

Method Summary

Modifier and Type	Method and Description
void	close() Closes this StatementCache and removes all entries from it.
boolean	isClosed() Returns true if this StatementCache is closed; false otherwise.
boolean	remove(StatementHolder statement) Removes an entry from the cache (if such) for the given statement.
int	removeAll(Connection rawConnection) Removes all entries from the cache (if any) for the given rawConnection.
boolean	restore(StatementHolder statement, boolean clearWarnings) Restores (i.e.
StatementHolder	take(StatementMethod statementMethod) Returns a possibly cached StatementHolder object for the given connection statement method.

Method Detail

take

StatementHolder take(StatementMethod statementMethod)
              throws SQLException

Returns a possibly cached StatementHolder object for the given connection statement method.

Parameters:

statementMethod - the statement method

Returns:

a retrieved from the cache or newly created StatementHolder object wrapping the raw PreparedStatement object

Throws:

SQLException - if the invoked underlying "prepare..." method throws an exception

restore

boolean restore(StatementHolder statement,
                boolean clearWarnings)

Restores (i.e. marks as available) the given StatementHolder back in the cache.

Parameters:

statement - the given StatementHolder

clearWarnings - if true will execute Statement.clearWarnings() on the underlying raw PreparedStatement

Returns:

true if successfully restored the statement in the cache, false otherwise

remove

boolean remove(StatementHolder statement)

Removes an entry from the cache (if such) for the given statement. Does not close the removed statement.

Parameters:

statement - the StatementHolder to be removed

Returns:

true if success, false otherwise

removeAll

int removeAll(Connection rawConnection)

Removes all entries from the cache (if any) for the given rawConnection. Closes all removed statements.

Parameters:

rawConnection - the connection for which the entries to be removed

Returns:

the number of removed entries

close

void close()

Closes this StatementCache and removes all entries from it.

isClosed

boolean isClosed()

Returns true if this StatementCache is closed; false otherwise.