org.skife.jdbi.v2.util

Class TypedMapper<T>

java.lang.Object

org.skife.jdbi.v2.util.TypedMapper<T>

All Implemented Interfaces:

ResultSetMapper<T>

Direct Known Subclasses:

BigDecimalMapper, BooleanMapper, ByteArrayMapper, ByteMapper, DoubleMapper, FloatMapper, IntegerMapper, LongMapper, ShortMapper, StringMapper, TimestampMapper, URLMapper

public abstract class TypedMapper<T>
extends Object
implements ResultSetMapper<T>

Convenience base class for implementing typed result set mappers. Provides frequently used functionality.

Constructor Summary

Constructors

Constructor and Description
TypedMapper() Create a new instance which extracts the value from the first column
TypedMapper(int index) Create a new instance which extracts the value positionally in the result set
TypedMapper(String name) Create a new instance which extracts the value by name or alias from the result set

Method Summary

Modifier and Type	Method and Description
protected abstract T	extractByIndex(ResultSet r, int index)
protected abstract T	extractByName(ResultSet r, String name)
T	map(int index, ResultSet r, StatementContext ctx) Map the row the result set is at when passed in.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedMapper

public TypedMapper()

Create a new instance which extracts the value from the first column

TypedMapper

public TypedMapper(int index)

Create a new instance which extracts the value positionally in the result set

Parameters:

index - 1 based column index into the result set

TypedMapper

public TypedMapper(String name)

Create a new instance which extracts the value by name or alias from the result set

Parameters:

name - The name or alias for the field

Method Detail

extractByIndex

protected abstract T extractByIndex(ResultSet r,
                                    int index)
                             throws SQLException

Throws:

SQLException

extractByName

protected abstract T extractByName(ResultSet r,
                                   String name)
                            throws SQLException

Throws:

SQLException

map

public final T map(int index,
                   ResultSet r,
                   StatementContext ctx)
            throws SQLException

Description copied from interface: ResultSetMapper

Map the row the result set is at when passed in. This method should not cause the result set to advance, allow jDBI to do that, please.

Specified by:

map in interface ResultSetMapper<T>

Parameters:

index - which row of the result set we are at, starts at 0

r - the result set being iterated

Returns:

the value to return for this row

Throws:

SQLException - if anythign goes wrong go ahead and let this percolate, jDBI will handle it