org.jdbi.v3.core.mapper

Class GenericMapMapperFactory

java.lang.Object

org.jdbi.v3.core.mapper.GenericMapMapperFactory

All Implemented Interfaces:

RowMapperFactory

@Beta
public class GenericMapMapperFactory
extends Object
implements RowMapperFactory

Factory for a RowMapper that can map resultset rows to column name/generic value Maps. Each row in the resultset becomes a distinct Map, in which the keys are all distinct column names and the values are the corresponding cell contents. All values are mapped to the same generic type T (e.g. BigDecimal) by a ColumnMapper from the ConfigRegistry. This differs from MapMapper by supporting a concrete type instead of only Object, and from collecting into a Map in that the latter maps an entire resultset to a single Map and can only keep 1 key and 1 value from each row. Use cases for this are mainly single-row results like numeric reports (e.g. the price components, taxes, etc of a product for sale, or a set of possible labeled values for a user setting), and matrices.

See Also:

ResultBearing.mapToMap(GenericType), MapMapper, ResultBearing.mapToMap(), ResultBearing.collectInto(GenericType)

Constructor Summary

Constructors

Constructor and Description
GenericMapMapperFactory()

Method Summary

Modifier and Type	Method and Description
Optional<RowMapper<?>>	build(Type mapType, ConfigRegistry config) Supplies a row mapper which will map result set rows to type if the factory supports it; empty otherwise.
static <T> RowMapper<Map<String,T>>	getMapperForValueType(Class<T> valueType, ConfigRegistry config)
static <T> RowMapper<Map<String,T>>	getMapperForValueType(GenericType<T> valueType, ConfigRegistry config)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jdbi.v3.core.mapper.RowMapperFactory

of

Constructor Detail

GenericMapMapperFactory

public GenericMapMapperFactory()

Method Detail

build

public Optional<RowMapper<?>> build(Type mapType,
                                    ConfigRegistry config)

Description copied from interface: RowMapperFactory

Supplies a row mapper which will map result set rows to type if the factory supports it; empty otherwise.

Specified by:

build in interface RowMapperFactory

Parameters:

mapType - the target type to map to

config - the config registry, for composition

Returns:

a row mapper for the given type if this factory supports it; Optional.empty() otherwise.

See Also:

for composition

getMapperForValueType

@Beta
public static <T> RowMapper<Map<String,T>> getMapperForValueType(Class<T> valueType,
                                                                       ConfigRegistry config)

getMapperForValueType

@Beta
public static <T> RowMapper<Map<String,T>> getMapperForValueType(GenericType<T> valueType,
                                                                       ConfigRegistry config)