net.sf.log4jdbc.sql.resultsetcollector

Class DefaultResultSetCollector

java.lang.Object

net.sf.log4jdbc.sql.resultsetcollector.DefaultResultSetCollector

All Implemented Interfaces:

ResultSetCollector

public class DefaultResultSetCollector
extends Object
implements ResultSetCollector

Constructor Summary

Constructors

Constructor and Description
DefaultResultSetCollector(boolean fillInUnreadValues)

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumnCount()
String	getColumnLabel(int column)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultResultSetCollector

public DefaultResultSetCollector(boolean fillInUnreadValues)

Method Detail

getRows

public List<List<Object>> getRows()

Specified by:

getRows in interface ResultSetCollector

Returns:

the result set objects

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface ResultSetCollector

Returns:

the result set column count

reset

public void reset()

Description copied from interface: ResultSetCollector

Clear the result set so far.

Specified by:

reset in interface ResultSetCollector

loadMetaDataIfNeeded

public void loadMetaDataIfNeeded(ResultSet rs)

Description copied from interface: ResultSetCollector

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).

Specified by:

loadMetaDataIfNeeded in interface ResultSetCollector

Parameters:

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

getColumnName

public String getColumnName(int column)

Specified by:

getColumnName in interface ResultSetCollector

Returns:

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

getColumnLabel

public String getColumnLabel(int column)

methodReturned

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

Description copied from interface: ResultSetCollector

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

Specified by:

methodReturned in interface ResultSetCollector

Returns:

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

preMethod

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

Description copied from interface: ResultSetCollector

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

Specified by:

preMethod in interface ResultSetCollector