org.sfm.jdbc

Class JdbcMapperBuilder<T>

java.lang.Object

org.sfm.map.impl.AbstractFieldMapperMapperBuilder<ResultSet,T,JdbcColumnKey>

org.sfm.jdbc.JdbcMapperBuilder<T>

Type Parameters:

T - the targeted type of the mapper

public final class JdbcMapperBuilder<T>
extends AbstractFieldMapperMapperBuilder<ResultSet,T,JdbcColumnKey>

Field Summary

Fields inherited from class org.sfm.map.impl.AbstractFieldMapperMapperBuilder

columnDefinitions, mapperBuilderErrorHandler, mappingContextFactoryBuilder, propertyNameMatcherFactory, reflectionService

Constructor Summary

Constructors

Constructor and Description
JdbcMapperBuilder(ClassMeta<T> classMeta, MapperBuilderErrorHandler mapperBuilderErrorHandler, ColumnDefinitionProvider<FieldMapperColumnDefinition<JdbcColumnKey,ResultSet>,JdbcColumnKey> columnDefinitions, PropertyNameMatcherFactory propertyNameMatcherFactory, GetterFactory<ResultSet,JdbcColumnKey> getterFactory, boolean failOnAsm, MappingContextFactoryBuilder<ResultSet,JdbcColumnKey> parentBuilder)
JdbcMapperBuilder(Type target) Build a new JdbcMapperBuilder targeting the specified type.
JdbcMapperBuilder(TypeReference<T> target) Build a new JdbcMapperBuilder targeting the type specified by the TypeReference.
JdbcMapperBuilder(Type target, ReflectionService reflectService) Build a new JdbcMapperBuilder targeting the specified type with the specified ReflectionService.

Method Summary

Methods

Modifier and Type	Method and Description
JdbcMapperBuilder<T>	addKey(String column) add a new mapping to the specified column with a key column definition and an undefined type.
JdbcMapperBuilder<T>	addMapper(FieldMapper<ResultSet,T> mapper) append a FieldMapper to the mapping list.
JdbcMapperBuilder<T>	addMapping(ResultSetMetaData metaData) add the all the column present in the metaData
JdbcMapperBuilder<T>	addMapping(String column) add a new mapping to the specified column with an undefined type.
JdbcMapperBuilder<T>	addMapping(String column, FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition) add a new mapping to the specified column with the specified columnDefinition and an undefined type.
JdbcMapperBuilder<T>	addMapping(String column, int index) add a new mapping to the specified column with the specified index and an undefined type.
JdbcMapperBuilder<T>	addMapping(String column, int index, FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition) add a new mapping to the specified column with the specified index, specified column definition and an undefined type.
JdbcMapperBuilder<T>	addMapping(String column, int index, int sqlType) add a new mapping to the specified column with the specified index and the specified type.
JdbcMapperBuilder<T>	addMapping(String column, int index, int sqlType, FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition) add a new mapping to the specified column with the specified index, the specified type.
JdbcMapperBuilder<T>	fieldMapperErrorHandler(FieldMapperErrorHandler<JdbcColumnKey> errorHandler) the FieldMapperErrorHandler is called when a error occurred when mapping a field from the source to the target.
JdbcMapperBuilder<T>	jdbcMapperErrorHandler(RowHandlerErrorHandler jdbcMapperErrorHandler) the RowHandlerErrorHandler is called when an exception is thrown by the RowHandler in the forEach call.
JdbcMapper<T>	mapper()
protected <ST> AbstractFieldMapperMapperBuilder<ResultSet,ST,JdbcColumnKey>	newSubBuilder(Type type, ClassMeta<ST> classMeta, MappingContextFactoryBuilder<ResultSet,JdbcColumnKey> mappingContextFactoryBuilder)

Methods inherited from class org.sfm.map.impl.AbstractFieldMapperMapperBuilder

_addMapper, _addMapping, addMapping, fields, getConstructorFieldMappersAndInstantiator, getTargetClass, newFieldMapper, setFieldMapperErrorHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcMapperBuilder

public JdbcMapperBuilder(TypeReference<T> target)

Build a new JdbcMapperBuilder targeting the type specified by the TypeReference. The TypeReference allow you to provide a generic type with check of T
new TypeReference<List<String>>() {}

Parameters:

target - the TypeReference to the type T to map to

JdbcMapperBuilder

public JdbcMapperBuilder(Type target)

Build a new JdbcMapperBuilder targeting the specified type.

Parameters:

target - the type

JdbcMapperBuilder

public JdbcMapperBuilder(Type target,
                 ReflectionService reflectService)

Build a new JdbcMapperBuilder targeting the specified type with the specified ReflectionService.

Parameters:

target - the type

reflectService - the ReflectionService

JdbcMapperBuilder

public JdbcMapperBuilder(ClassMeta<T> classMeta,
                 MapperBuilderErrorHandler mapperBuilderErrorHandler,
                 ColumnDefinitionProvider<FieldMapperColumnDefinition<JdbcColumnKey,ResultSet>,JdbcColumnKey> columnDefinitions,
                 PropertyNameMatcherFactory propertyNameMatcherFactory,
                 GetterFactory<ResultSet,JdbcColumnKey> getterFactory,
                 boolean failOnAsm,
                 MappingContextFactoryBuilder<ResultSet,JdbcColumnKey> parentBuilder)

Parameters:

classMeta - the meta for the target class.

mapperBuilderErrorHandler - the error handler.

columnDefinitions - the predefined ColumnDefninition.

propertyNameMatcherFactory - the PropertyNameMatcher factory.

getterFactory - the Getter factory.

failOnAsm - should we fail on asm generation.

parentBuilder - the parent builder, null if none.

Method Detail

mapper

public JdbcMapper<T> mapper()

Specified by:

mapper in class AbstractFieldMapperMapperBuilder<ResultSet,T,JdbcColumnKey>

Returns:

a new instance of the mapper based on the current state of the builder.

addKey

public JdbcMapperBuilder<T> addKey(String column)

add a new mapping to the specified column with a key column definition and an undefined type. The index is incremented for each non indexed column mapping.

Parameters:

column - the column name

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(String column)

add a new mapping to the specified column with an undefined type. The index is incremented for each non indexed column mapping.

Parameters:

column - the column name

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(String column,
                              FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)

add a new mapping to the specified column with the specified columnDefinition and an undefined type. The index is incremented for each non indexed column mapping.

Parameters:

column - the column name

columnDefinition - the definition

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(String column,
                              int index)

add a new mapping to the specified column with the specified index and an undefined type.

Parameters:

column - the column name

index - the column index

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(String column,
                              int index,
                              FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)

add a new mapping to the specified column with the specified index, specified column definition and an undefined type.

Parameters:

column - the column name

index - the column index

columnDefinition - the column definition

Returns:

the current builder

addMapper

public JdbcMapperBuilder<T> addMapper(FieldMapper<ResultSet,T> mapper)

append a FieldMapper to the mapping list.

Parameters:

mapper - the field mapper

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(String column,
                              int index,
                              int sqlType)

add a new mapping to the specified column with the specified index and the specified type.

Parameters:

column - the column name

index - the column index

sqlType - the column type, @see java.sql.Types

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(String column,
                              int index,
                              int sqlType,
                              FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)

add a new mapping to the specified column with the specified index, the specified type.

Parameters:

column - the column name

index - the column index

sqlType - the column type, @see java.sql.Types

columnDefinition - the column definition

Returns:

the current builder

addMapping

public JdbcMapperBuilder<T> addMapping(ResultSetMetaData metaData)
                                throws SQLException

add the all the column present in the metaData

Parameters:

metaData - the metaDAta

Returns:

the current builder

Throws:

SQLException

newSubBuilder

protected <ST> AbstractFieldMapperMapperBuilder<ResultSet,ST,JdbcColumnKey> newSubBuilder(Type type,
                                                                              ClassMeta<ST> classMeta,
                                                                              MappingContextFactoryBuilder<ResultSet,JdbcColumnKey> mappingContextFactoryBuilder)

Specified by:

newSubBuilder in class AbstractFieldMapperMapperBuilder<ResultSet,T,JdbcColumnKey>

fieldMapperErrorHandler

public JdbcMapperBuilder<T> fieldMapperErrorHandler(FieldMapperErrorHandler<JdbcColumnKey> errorHandler)

the FieldMapperErrorHandler is called when a error occurred when mapping a field from the source to the target. By default it just throw the Exception.

Parameters:

errorHandler - the new FieldMapperErrorHandler

Returns:

the current builder

jdbcMapperErrorHandler

public JdbcMapperBuilder<T> jdbcMapperErrorHandler(RowHandlerErrorHandler jdbcMapperErrorHandler)

the RowHandlerErrorHandler is called when an exception is thrown by the RowHandler in the forEach call.

Parameters:

jdbcMapperErrorHandler - the new RowHandlerErrorHandler

Returns:

the current builder