org.apache.commons.dbutils.handlers
Class MapListHandler

java.lang.Object
  org.apache.commons.dbutils.handlers.GenericListHandler
      org.apache.commons.dbutils.handlers.MapListHandler

All Implemented Interfaces:

ResultSetHandler

public class MapListHandler

extends org.apache.commons.dbutils.handlers.GenericListHandler

ResultSetHandler implementation that converts a ResultSet into a List of Maps. This class is thread safe.

See Also:

ResultSetHandler

Constructor Summary

MapListHandler()
Creates a new instance of MapListHandler using a BasicRowProcessor for conversion.

MapListHandler(RowProcessor convert)
Creates a new instance of MapListHandler.

Method Summary

java.lang.Object	handle(java.sql.ResultSet rs) Whole ResultSet handler.
protected java.lang.Object	handleRow(java.sql.ResultSet rs) Converts the ResultSet row into a Map object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapListHandler

public MapListHandler()

Creates a new instance of MapListHandler using a BasicRowProcessor for conversion.

MapListHandler

public MapListHandler(RowProcessor convert)

Creates a new instance of MapListHandler.

Parameters:

convert - The RowProcessor implementation to use when converting rows into Maps.

Method Detail

handleRow

protected java.lang.Object handleRow(java.sql.ResultSet rs)
                              throws java.sql.SQLException

Converts the ResultSet row into a Map object.

Parameters:

rs - ResultSet to process.

Returns:

A Map, never null.

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

GenericListHandler.handle(ResultSet)

handle

public java.lang.Object handle(java.sql.ResultSet rs)
                        throws java.sql.SQLException

Whole ResultSet handler. It produce List as result. To convert individual rows into Java objects it uses handleRow(ResultSet) method.

Specified by:

handle in interface ResultSetHandler

Parameters:

rs - The ResultSet to handle. It has not been touched before being passed to this method.

Returns:

An Object initialized with ResultSet data. It is legal for implementations to return null if the ResultSet contained 0 rows.

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

GenericListHandler.handleRow(ResultSet)