Package org.apache.commons.dbutils

Class BasicRowProcessor

java.lang.Object

org.apache.commons.dbutils.BasicRowProcessor

All Implemented Interfaces:

RowProcessor

public class BasicRowProcessor
extends Object
implements RowProcessor

Basic implementation of the RowProcessor interface.

This class is thread-safe.

See Also:

• RowProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	BasicRowProcessor.CaseInsensitiveHashMap	A Map that converts all keys to lowercase Strings for case insensitive lookups.

Field Summary

Fields

Modifier and Type	Field	Description
private final BeanProcessor	convert	Use this to process beans.
private static final BeanProcessor	defaultConvert	The default BeanProcessor instance to use if not supplied in the constructor.
private static final BasicRowProcessor	instance	The Singleton instance of this class.

Constructor Summary

Constructors

Constructor	Description
BasicRowProcessor()	BasicRowProcessor constructor.
BasicRowProcessor(BeanProcessor convert)	BasicRowProcessor constructor.

Method Summary

Modifier and Type	Method	Description
protected static Map<String,Object>	createCaseInsensitiveHashMap(int cols)
static BasicRowProcessor	instance()	Deprecated. Create instances with the constructors instead.
Object[]	toArray(ResultSet resultSet)	Convert a ResultSet row into an Object[].
<T> T	toBean(ResultSet resultSet, Class<? extends T> type)	Convert a ResultSet row into a JavaBean.
<T> List<T>	toBeanList(ResultSet resultSet, Class<? extends T> type)	Convert a ResultSet into a List of JavaBeans.
Map<String,Object>	toMap(ResultSet resultSet)	Convert a ResultSet row into a Map.

Methods inherited from class java.lang.Object

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

Field Details

defaultConvert

private static final BeanProcessor defaultConvert

The default BeanProcessor instance to use if not supplied in the constructor.

instance

private static final BasicRowProcessor instance

The Singleton instance of this class.

convert

private final BeanProcessor convert

Use this to process beans.

Constructor Details

BasicRowProcessor

public BasicRowProcessor()

BasicRowProcessor constructor. Bean processing defaults to a BeanProcessor instance.

BasicRowProcessor

public BasicRowProcessor(BeanProcessor convert)

BasicRowProcessor constructor.

Parameters:

convert - The BeanProcessor to use when converting columns to bean properties.

Since:

1.1

Method Details

createCaseInsensitiveHashMap

protected static Map<String,Object> createCaseInsensitiveHashMap(int cols)

instance

@Deprecated
public static BasicRowProcessor instance()

Deprecated.

Create instances with the constructors instead. This will be removed after DbUtils 1.1.

Returns the Singleton instance of this class.

Returns:

The single instance of this class.

toArray

public Object[] toArray(ResultSet resultSet)
                 throws SQLException

Convert a ResultSet row into an Object[]. This implementation copies column values into the array in the same order they're returned from the ResultSet. Array elements will be set to null if the column was SQL NULL.

Specified by:

toArray in interface RowProcessor

Parameters:

resultSet - ResultSet that supplies the array data

Returns:

the newly created array

Throws:

SQLException - if a database access error occurs

See Also:

• RowProcessor.toArray(java.sql.ResultSet)

toBean

public <T> T toBean(ResultSet resultSet,
 Class<? extends T> type)
             throws SQLException

Convert a ResultSet row into a JavaBean. This implementation delegates to a BeanProcessor instance.

Specified by:

toBean in interface RowProcessor

Type Parameters:

T - The type of bean to create

Parameters:

resultSet - ResultSet that supplies the bean data

type - Class from which to create the bean instance

Returns:

the newly created bean

Throws:

SQLException - if a database access error occurs

See Also:

• RowProcessor.toBean(java.sql.ResultSet, Class)
• BeanProcessor.toBean(java.sql.ResultSet, Class)

toBeanList

public <T> List<T> toBeanList(ResultSet resultSet,
 Class<? extends T> type)
                       throws SQLException

Convert a ResultSet into a List of JavaBeans. This implementation delegates to a BeanProcessor instance.

Specified by:

toBeanList in interface RowProcessor

Type Parameters:

T - The type of bean to create

Parameters:

resultSet - ResultSet that supplies the bean data

type - Class from which to create the bean instance

Returns:

A List of beans with the given type in the order they were returned by the ResultSet.

Throws:

SQLException - if a database access error occurs

See Also:

• RowProcessor.toBeanList(java.sql.ResultSet, Class)
• BeanProcessor.toBeanList(java.sql.ResultSet, Class)

toMap

public Map<String,Object> toMap(ResultSet resultSet)
                         throws SQLException

Convert a ResultSet row into a Map.

This implementation returns a Map with case insensitive column names as keys. Calls to map.get("COL") and map.get("col") return the same value. Furthermore this implementation will return an ordered map, that preserves the ordering of the columns in the ResultSet, so that iterating over the entry set of the returned map will return the first column of the ResultSet, then the second and so forth.

Specified by:

toMap in interface RowProcessor

Parameters:

resultSet - ResultSet that supplies the map data

Returns:

the newly created Map

Throws:

SQLException - if a database access error occurs

See Also:

• RowProcessor.toMap(java.sql.ResultSet)