org.apache.commons.dbutils.handlers
Class ColumnListHandler

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

All Implemented Interfaces:

ResultSetHandler

public class ColumnListHandler

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

ResultSetHandler implementation that converts one ResultSet column into a List of Objects. This class is thread safe.

Since:

DbUtils 1.1

See Also:

ResultSetHandler

Constructor Summary

ColumnListHandler()
Creates a new instance of ColumnListHandler.

ColumnListHandler(int columnIndex)
Creates a new instance of ColumnListHandler.

ColumnListHandler(java.lang.String columnName)
Creates a new instance of ColumnListHandler.

Method Summary

java.lang.Object	handle(java.sql.ResultSet rs) Whole ResultSet handler.
protected java.lang.Object	handleRow(java.sql.ResultSet rs) Returns one ResultSet column value as Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnListHandler

public ColumnListHandler()

Creates a new instance of ColumnListHandler. The first column of each row will be returned from handle().

ColumnListHandler

public ColumnListHandler(int columnIndex)

Creates a new instance of ColumnListHandler.

Parameters:

columnIndex - The index of the column to retrieve from the ResultSet.

ColumnListHandler

public ColumnListHandler(java.lang.String columnName)

Creates a new instance of ColumnListHandler.

Parameters:

columnName - The name of the column to retrieve from the ResultSet.

Method Detail

handleRow

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

Returns one ResultSet column value as Object.

Parameters:

rs - ResultSet to process.

Returns:

Object, 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)