net.sf.log4jdbc.sql.resultsetcollector

Interface ResultSetCollector

All Known Implementing Classes:

DefaultResultSetCollector

public interface ResultSetCollector

Collect a result set, ultimately available from getRow(). A ResultSetSpy instance may call a ResultSetCollector instance's methodReturned and preMethod as and when appropriate. The ResultSetCollector is then expected to build a simple representation of the rows and columns in getRow()/getColumnCount()/getColumnName().

Author:

Tim Azzopardi

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumnCount()
String	getColumnName(int column)
List<List<Object>>	getRows()
void	loadMetaDataIfNeeded(ResultSet rs) Allow this ResultSetCollector to obtain a ResultSetMetaData from the real underlying JDBC ResultSet, and obtains immediately from it the column count, the column names and column labels.
boolean	methodReturned(ResultSetSpy resultSetSpy, String methodCall, Object returnValue, Object targetObject, Object... methodParams) Expected to be called by a ResultSetSpy for all jdbc methods.
void	preMethod(ResultSetSpy resultSetSpy, String methodCall, Object... methodParams) Expected to be called by a ResultSetSpy for prior to the execution of all jdbc methods.
void	reset() Clear the result set so far.

Method Detail

methodReturned

boolean methodReturned(ResultSetSpy resultSetSpy,
                     String methodCall,
                     Object returnValue,
                     Object targetObject,
                     Object... methodParams)

Expected to be called by a ResultSetSpy for all jdbc methods.

Returns:

true if the result set is complete (next() returns false)

preMethod

void preMethod(ResultSetSpy resultSetSpy,
             String methodCall,
             Object... methodParams)

Expected to be called by a ResultSetSpy for prior to the execution of all jdbc methods.

getRows

List<List<Object>> getRows()

Returns:

the result set objects

getColumnCount

int getColumnCount()

Returns:

the result set column count

getColumnName

String getColumnName(int column)

Returns:

the result set column name for a given column number previously obtained from the ResultSetMetaData. Index starts from 1.

reset

void reset()

Clear the result set so far.

loadMetaDataIfNeeded

void loadMetaDataIfNeeded(ResultSet rs)

Allow this ResultSetCollector to obtain a ResultSetMetaData from the real underlying JDBC ResultSet, and obtains immediately from it the column count, the column names and column labels. This information needs to be stored, to be later used by the methods getColumnCount and getColumnName, when this ResultSetCollector is printed. It is not possible to simply store the ResultSetMetaData, as the ResultSet might be closed at the time of printing, and some drivers do not support to query the ResultSetMetaData when the ResultSet is closed.

The ResultSetMetaData should be requested and the data obtained by this method only once, so a control needs to be done before obtaining the ResultSetMetaData. This method should also first check if rs is not already closed. This methods is usually called under the hood by the ResultSetCollector itself, but it might by required to manually load the ResultSetMetaData if, for instance, the real ResultSet is about to be closed before the ResultSetCollector requested for the ResultSetMetaData (for instance, if the method next was not previously called).

Parameters:

rs - The real JDBC ResultSet that was wrapped into a ResultSetSpy.