Package org.jdbi.v3.core.result

Class BatchResultBearing

java.lang.Object

org.jdbi.v3.core.result.BatchResultBearing

All Implemented Interfaces:

ResultBearing

public final class BatchResultBearing
extends java.lang.Object
implements ResultBearing

Extends the ResultBearing class to provide access to the per-batch row modification counts.

Field Summary

Fields

Modifier and Type	Field	Description
private ResultBearing	delegate
private java.util.function.Supplier<int[]>	modifiedRowCountsSupplier

Constructor Summary

Constructors

Constructor	Description
BatchResultBearing(ResultBearing delegate, java.util.function.Supplier<int[]> modifiedRowCountsSupplier)

Method Summary

Modifier and Type	Method	Description
<R> R	collectInto(java.lang.Class<R> containerType)	Collect the results into a container of the given type.
java.lang.Object	collectInto(java.lang.reflect.Type containerType)	Collect the results into a container of the given type.
<R> R	collectInto(GenericType<R> containerType)	Collect the results into a container of the given generic type.
<A,R> R	collectRows(java.util.stream.Collector<RowView,A,R> collector)	Collect the results using the given collector.
<T> BatchResultIterable<T>	map(ColumnMapper<T> mapper)	Maps this result set to a ResultIterable, using the given column mapper.
<T> BatchResultIterable<T>	map(RowMapper<T> mapper)	Maps this result set to a ResultIterable, using the given row mapper.
<T> BatchResultIterable<T>	map(RowViewMapper<T> mapper)	Maps this result set to a ResultIterable, using the given RowViewMapper.
<T> BatchResultIterable<T>	mapTo(java.lang.Class<T> type)	Maps this result set to a ResultIterable of the given element type.
BatchResultIterable<?>	mapTo(java.lang.reflect.Type type)	Maps this result set to a ResultIterable of the given element type.
<T> BatchResultIterable<T>	mapTo(GenericType<T> type)	Maps this result set to a ResultIterable of the given element type.
<T> BatchResultIterable<T>	mapTo(QualifiedType<T> type)	Maps this result set to a ResultIterable of the given qualified element type.
<T> BatchResultIterable<T>	mapToBean(java.lang.Class<T> type)	Maps this result set to a ResultIterable of the given element type, using BeanMapper.
BatchResultIterable<java.util.Map<java.lang.String,java.lang.Object>>	mapToMap()	Maps this result set to a ResultIterable of Map<String,Object>.
<T> BatchResultIterable<java.util.Map<java.lang.String,T>>	mapToMap(java.lang.Class<T> valueType)	Maps this result set to a Map of String and the given value class.
<T> BatchResultIterable<java.util.Map<java.lang.String,T>>	mapToMap(GenericType<T> valueType)	Maps this result set to a Map of String and the given value type.
int[]	modifiedRowCounts()	Returns the mod counts for the executed PreparedBatch Note that some database drivers might return special values like Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED.
<U> U	reduceResultSet(U seed, ResultSetAccumulator<U> accumulator)	Reduce the results.
<K,V> java.util.stream.Stream<V>	reduceRows(java.util.function.BiConsumer<java.util.Map<K,V>,RowView> accumulator)	Reduce the result rows using a Map<K, V> as the result container.
<C,R> java.util.stream.Stream<R>	reduceRows(RowReducer<C,R> rowReducer)	Reduce the result rows using the given row reducer.
<U> U	reduceRows(U seed, java.util.function.BiFunction<U,RowView,U> accumulator)	Reduce the results.
<R> R	scanResultSet(ResultSetScanner<R> resultSetScanner)	Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

private final ResultBearing delegate

modifiedRowCountsSupplier

private final java.util.function.Supplier<int[]> modifiedRowCountsSupplier

Constructor Detail

BatchResultBearing

public BatchResultBearing(ResultBearing delegate,
                          java.util.function.Supplier<int[]> modifiedRowCountsSupplier)

Method Detail

scanResultSet

public <R> R scanResultSet(ResultSetScanner<R> resultSetScanner)

Description copied from interface: ResultBearing

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

Specified by:

scanResultSet in interface ResultBearing

Type Parameters:

R - result type returned by the mapper.

Parameters:

resultSetScanner - result set scanner

Returns:

the value returned by the mapper.

mapTo

public <T> BatchResultIterable<T> mapTo(java.lang.Class<T> type)

Description copied from interface: ResultBearing

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

Specified by:

mapTo in interface ResultBearing

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(org.jdbi.v3.core.mapper.RowMapperFactory), Configurable.registerColumnMapper(org.jdbi.v3.core.mapper.ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapTo

public <T> BatchResultIterable<T> mapTo(GenericType<T> type)

Description copied from interface: ResultBearing

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

Specified by:

mapTo in interface ResultBearing

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(org.jdbi.v3.core.mapper.RowMapperFactory), Configurable.registerColumnMapper(org.jdbi.v3.core.mapper.ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapTo

public BatchResultIterable<?> mapTo(java.lang.reflect.Type type)

Description copied from interface: ResultBearing

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

Specified by:

mapTo in interface ResultBearing

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(org.jdbi.v3.core.mapper.RowMapperFactory), Configurable.registerColumnMapper(org.jdbi.v3.core.mapper.ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapTo

public <T> BatchResultIterable<T> mapTo(QualifiedType<T> type)

Description copied from interface: ResultBearing

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

Specified by:

mapTo in interface ResultBearing

Parameters:

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

Returns:

a ResultIterable of the given type.

See Also:

Configurable.registerRowMapper(RowMapper), Configurable.registerRowMapper(org.jdbi.v3.core.mapper.RowMapperFactory), Configurable.registerColumnMapper(org.jdbi.v3.core.mapper.ColumnMapperFactory), Configurable.registerColumnMapper(ColumnMapper)

mapToBean

public <T> BatchResultIterable<T> mapToBean(java.lang.Class<T> type)

Description copied from interface: ResultBearing

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

Specified by:

mapToBean in interface ResultBearing

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

public BatchResultIterable<java.util.Map<java.lang.String,java.lang.Object>> mapToMap()

Description copied from interface: ResultBearing

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

Specified by:

mapToMap in interface ResultBearing

Returns:

a ResultIterable<Map<String,Object>>.

mapToMap

public <T> BatchResultIterable<java.util.Map<java.lang.String,T>> mapToMap(java.lang.Class<T> valueType)

Description copied from interface: ResultBearing

Maps this result set to a Map of String and the given value class.

Specified by:

mapToMap in interface ResultBearing

Type Parameters:

T - the value type

Parameters:

valueType - the class to map the resultset columns to

Returns:

a Map of String and the given type.

See Also:

Configurable.registerColumnMapper(ColumnMapper)

mapToMap

public <T> BatchResultIterable<java.util.Map<java.lang.String,T>> mapToMap(GenericType<T> valueType)

Description copied from interface: ResultBearing

Maps this result set to a Map of String and the given value type.

Specified by:

mapToMap in interface ResultBearing

Type Parameters:

T - the value type

Parameters:

valueType - the type to map the resultset columns to

Returns:

a Map of String and the given type.

See Also:

Configurable.registerColumnMapper(ColumnMapper)

map

public <T> BatchResultIterable<T> map(ColumnMapper<T> mapper)

Description copied from interface: ResultBearing

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

Specified by:

map in interface ResultBearing

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

public <T> BatchResultIterable<T> map(RowMapper<T> mapper)

Description copied from interface: ResultBearing

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

Specified by:

map in interface ResultBearing

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>.

map

public <T> BatchResultIterable<T> map(RowViewMapper<T> mapper)

Description copied from interface: ResultBearing

Maps this result set to a ResultIterable, using the given RowViewMapper. This overload only exists to allow RowViewMapper as the type of a lambda expression.

Specified by:

map in interface ResultBearing

Type Parameters:

T - the type to map the result set rows to

Parameters:

mapper - RowViewMapper used to map each row

Returns:

a ResultIterable of type <T>.

reduceRows

public <C,R> java.util.stream.Stream<R> reduceRows(RowReducer<C,R> rowReducer)

Description copied from interface: ResultBearing

Reduce the result rows using the given row reducer.

Specified by:

reduceRows in interface ResultBearing

Type Parameters:

C - Mutable result container type

R - Result element type

Parameters:

rowReducer - the row reducer.

Returns:

the stream of result elements

See Also:

RowReducer

reduceRows

public <K,V> java.util.stream.Stream<V> reduceRows(java.util.function.BiConsumer<java.util.Map<K,V>,RowView> accumulator)

Description copied from interface: ResultBearing

Reduce the result rows using a Map<K, V> as the result container.

Specified by:

reduceRows in interface ResultBearing

Type Parameters:

K - map key type

V - map value type

Parameters:

accumulator - accumulator function which gathers data from each RowView into the result map.

Returns:

the stream of elements in the container's Map.values() collection, in the order they were inserted.

reduceRows

public <U> U reduceRows(U seed,
                        java.util.function.BiFunction<U,RowView,U> accumulator)

Description copied from interface: ResultBearing

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

Specified by:

reduceRows in interface ResultBearing

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

reduceResultSet

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

Description copied from interface: ResultBearing

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

Specified by:

reduceResultSet in interface ResultBearing

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

collectRows

public <A,R> R collectRows(java.util.stream.Collector<RowView,A,R> collector)

Description copied from interface: ResultBearing

Collect the results using the given collector. Do not attempt to accumulate the RowView objects into the result--they are only valid within the Collector.accumulator() function. Instead, extract mapped types from the RowView by calling RowView.getRow() or RowView.getColumn().

Specified by:

collectRows in interface ResultBearing

Type Parameters:

A - the mutable accumulator type used by the collector.

R - the result type returned by the collector.

Parameters:

collector - the collector to collect the result rows.

Returns:

the result of the collection

collectInto

public <R> R collectInto(java.lang.Class<R> containerType)

Description copied from interface: ResultBearing

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).

Specified by:

collectInto in interface ResultBearing

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

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

Description copied from interface: ResultBearing

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>>() {});
 

Specified by:

collectInto in interface ResultBearing

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

public java.lang.Object collectInto(java.lang.reflect.Type containerType)

Description copied from interface: ResultBearing

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).

Specified by:

collectInto in interface ResultBearing

Parameters:

containerType - the container type into which results will be collected

Returns:

a container into which result rows have been collected

modifiedRowCounts

public int[] modifiedRowCounts()

Returns the mod counts for the executed PreparedBatch Note that some database drivers might return special values like Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED.
Note that the result is only available after the statement was executed (eg. by calling map()). Calling this method before execution will return an empty array.

Returns:

the number of modified rows per batch part for the executed PreparedBatch.