Package org.apache.commons.dbutils
Interface ColumnHandler
-
- All Known Implementing Classes:
BooleanColumnHandler
,ByteColumnHandler
,DoubleColumnHandler
,FloatColumnHandler
,IntegerColumnHandler
,LongColumnHandler
,ShortColumnHandler
,SQLXMLColumnHandler
,StringColumnHandler
,TimestampColumnHandler
public interface ColumnHandler
Interface to define how implementations can interact with column handling when constructing a bean from aResultSet
. ColumnHandlers do the work of retrieving data correctly from theResultSet
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
apply(java.sql.ResultSet rs, int columnIndex)
Do the work required to retrieve and store a column fromResultSet
into something of typepropType
.boolean
match(java.lang.Class<?> propType)
Test whether thisColumnHandler
wants to handle a column targeted for a value type matchingpropType
.
-
-
-
Method Detail
-
match
boolean match(java.lang.Class<?> propType)
Test whether thisColumnHandler
wants to handle a column targeted for a value type matchingpropType
.- Parameters:
propType
- The type of the target parameter.- Returns:
- true is this property handler can/wants to handle this value; false otherwise.
-
apply
java.lang.Object apply(java.sql.ResultSet rs, int columnIndex) throws java.sql.SQLException
Do the work required to retrieve and store a column fromResultSet
into something of typepropType
. This method is called only if this handler respondedtrue
after a call tomatch(Class)
.- Parameters:
rs
- The result set to get data from. This should be moved to the correct row already.columnIndex
- The position of the column to retrieve.- Returns:
- The converted value or the original value if something doesn't work out.
- Throws:
java.sql.SQLException
- if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set
-
-