org.jdbi.v3.core.result

Interface ResultBearing

All Known Implementing Classes:

PreparedBatch, Query

public interface ResultBearing

Provides access to the contents of a ResultSet by mapping to Java types.

Method Summary

Modifier and Type	Method and Description
default <R> R	collectInto(Class<R> containerType) Collect the results into a container of the given type.
default <R> R	collectInto(GenericType<R> containerType) Collect the results into a container of the given generic type.
default Object	collectInto(Type containerType) Collect the results into a container of the given type.
default <T> ResultIterable<T>	map(ColumnMapper<T> mapper) Maps this result set to a ResultIterable, using the given column mapper.
default <T> ResultIterable<T>	map(RowMapper<T> mapper) Maps this result set to a ResultIterable, using the given row mapper.
default <T> ResultIterable<T>	mapTo(Class<T> type) Maps this result set to a ResultIterable of the given element type.
default <T> ResultIterable<T>	mapTo(GenericType<T> type) Maps this result set to a ResultIterable of the given element type.
default ResultIterable<?>	mapTo(Type type) Maps this result set to a ResultIterable of the given element type.
default <T> ResultIterable<T>	mapToBean(Class<T> type) Maps this result set to a ResultIterable of the given element type, using BeanMapper.
default ResultIterable<Map<String,Object>>	mapToMap() Maps this result set to a ResultIterable of Map<String,Object>.
static ResultBearing	of(Supplier<ResultSet> resultSetSupplier, StatementContext ctx) Returns a ResultBearing backed by the given result set supplier and context.
default <U> U	reduceResultSet(U seed, ResultSetAccumulator<U> accumulator) Reduce the results.
default <U> U	reduceRows(U seed, BiFunction<U,RowView,U> accumulator) Reduce the results.
<R> R	scanResultSet(ResultSetScanner<R> mapper) Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

Method Detail

collectInto

default <R> R collectInto(Class<R> containerType)

Collect the results into a container of the given type. A collector must be registered for the container type, which knows the element type for the container. A mapper must be registered for the element type.

This method is equivalent to ResultBearing.mapTo(elementType).collect(containerCollector).

Type Parameters:

R - the result container type

Parameters:

containerType - the container type into which results will be collected

Returns:

a container into which result rows have been collected

collectInto

default <R> R collectInto(GenericType<R> containerType)

Collect the results into a container of the given generic type. A collector must be registered for the container type, which knows the element type for the container. A mapper must be registered for the element type.

This method is equivalent to ResultBearing.mapTo(elementType).collect(containerCollector).

Example:

 Map<Long, User> usersById = handle.createQuery("select * from user")
     .configure(MapEntryMappers.class, cfg -> cfg.setKeyColumn("id"))
     .collectInto(new GenericType<Map<Long, User>>() {});
 

Type Parameters:

R - the result container type

Parameters:

containerType - the container type into which results will be collected

Returns:

a container into which result rows have been collected

collectInto

default Object collectInto(Type containerType)

Collect the results into a container of the given type. A collector must be registered for the container type, which knows the element type for the container. A mapper must be registered for the element type.

This method is equivalent to ResultBearing.mapTo(elementType).collect(containerCollector).

Parameters:

containerType - the container type into which results will be collected

Returns:

a container into which result rows have been collected

map

default <T> ResultIterable<T> map(ColumnMapper<T> mapper)

Maps this result set to a ResultIterable, using the given column mapper.

Type Parameters:

T - the type to map the result set rows to

Parameters:

mapper - column mapper used to map the first column of each row

Returns:

a ResultIterable of type <T>.

map

default <T> ResultIterable<T> map(RowMapper<T> mapper)

Maps this result set to a ResultIterable, using the given row mapper.

Type Parameters:

T - the type to map the result set rows to

Parameters:

mapper - mapper used to map each row

Returns:

a ResultIterable of type <T>.

mapTo

default <T> ResultIterable<T> mapTo(Class<T> type)

Maps this result set to a ResultIterable of the given element type.

Type Parameters:

T - the type to map the result set rows to

Parameters:

type - the type to map the result set rows to

Returns:

a ResultIterable of the given type.

See Also:

Configurable.registerRowMapper(RowMapper), Configurable.registerRowMapper(RowMapperFactory), Configurable.registerColumnMapper(ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapTo

default <T> ResultIterable<T> mapTo(GenericType<T> type)

Maps this result set to a ResultIterable of the given element type.

Type Parameters:

T - the type to map the result set rows to

Parameters:

type - the type to map the result set rows to

Returns:

a ResultIterable of the given type.

See Also:

Configurable.registerRowMapper(RowMapper), Configurable.registerRowMapper(RowMapperFactory), Configurable.registerColumnMapper(ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapTo

default ResultIterable<?> mapTo(Type type)

Maps this result set to a ResultIterable of the given element type.

Parameters:

type - the type to map the result set rows to

Returns:

a ResultIterable of the given type.

See Also:

Configurable.registerRowMapper(RowMapper), Configurable.registerRowMapper(RowMapperFactory), Configurable.registerColumnMapper(ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapToBean

default <T> ResultIterable<T> mapToBean(Class<T> type)

Maps this result set to a ResultIterable of the given element type, using BeanMapper.

Type Parameters:

T - the bean type to map the result set rows to

Parameters:

type - the bean type to map the result set rows to

Returns:

a ResultIterable of the given type.

mapToMap

default ResultIterable<Map<String,Object>> mapToMap()

Maps this result set to a ResultIterable of Map<String,Object>. Keys are column names, and values are column values.

Returns:

a ResultIterable<Map<String,Object>>.

of

static ResultBearing of(Supplier<ResultSet> resultSetSupplier,
                        StatementContext ctx)

Returns a ResultBearing backed by the given result set supplier and context.

Parameters:

resultSetSupplier - result set supplier

ctx - the statement context

Returns:

a ResultBearing

reduceResultSet

default <U> U reduceResultSet(U seed,
                              ResultSetAccumulator<U> accumulator)

Reduce the results. Using a ResultSetAccumulator, repeatedly combine query results until only a single value remains.

Type Parameters:

U - the accumulator type

Parameters:

seed - the U to combine with the first result

accumulator - the function to apply repeatedly

Returns:

the final U

reduceRows

default <U> U reduceRows(U seed,
                         BiFunction<U,RowView,U> accumulator)

Reduce the results. Using a BiFunction<U, RowView, U>, repeatedly combine query results until only a single value remains.

Type Parameters:

U - the type of the accumulator

Parameters:

seed - the U to combine with the first result

accumulator - the function to apply repeatedly

Returns:

the final U

scanResultSet

<R> R scanResultSet(ResultSetScanner<R> mapper)

Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

Type Parameters:

R - result type returned by the mapper.

Parameters:

mapper - result set mapper

Returns:

the value returned by the mapper.