JdbcMapperFactory (SimpleFlatMapper 1.8.0 API)

java.lang.Object
- org.sfm.jdbc.JdbcMapperFactory

```
public final class JdbcMapperFactory
extends Object
```
JdbcMapperFactory allows you to customise the mappers and create an instance of it using a fluent syntax.
JdbcMapperFactory is not Thread-Safe but the mappers are. It is strongly advised to instantiate one mapper per class for the life of your application.
You can instantiate dynamic mapper which will use the ResultSetMetaData to figure out the list of the columns or a static one using a builder.
// create a dynamic mapper targeting MyClass JdbcMapperFactory .newInstance() .newMapper(MyClass.class); // create a static mapper targeting MyClass JdbcMapperFactory .newInstance() .newBuilder(MyClass.class) .addMapping("id") .addMapping("field1") .addMapping("field2") .mapper();

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JdbcMapperFactory`	`addAlias(String key, String value)` Associate an alias on the column key to rename to value.
`JdbcMapperFactory`	`addAliases(Map<String,String> aliases)` Associate the aliases value to the column key.
`JdbcMapperFactory`	`addColumnDefinition(Predicate<? super JdbcColumnKey> predicate, FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)` Associate the specified columnDefinition to the column matching the predicate.
`JdbcMapperFactory`	`addColumnDefinition(String key, FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)` Associate the specified columnDefinition to the specified column.
`JdbcMapperFactory`	`addCustomFieldMapper(String key, FieldMapper<ResultSet,?> fieldMapper)` Associate the specified FieldMapper for the specified column.
`JdbcMapperFactory`	`addCustomGetter(String key, Getter<ResultSet,?> getter)` Associate the specified Getter for the specified column.
`JdbcMapperFactory`	`addKeys(String... columns)` Mark the specified columns as keys.
`JdbcMapperFactory`	`asmMapperNbFieldsLimit(int asmMapperNbFieldsLimit)` change the number of fields threshold after which an asm mapper is not generated.
`JdbcMapperFactory`	`disableAsm(boolean disableAsm)`
`JdbcMapperFactory`	`failOnAsm(boolean b)`
`JdbcMapperFactory`	`fieldMapperErrorHandler(FieldMapperErrorHandler<JdbcColumnKey> fieldMapperErrorHandler)` the FieldMapperErrorHandler is called when a error occurred when mapping a field from the source to the target.
`JdbcMapperFactory`	`getterFactory(GetterFactory<ResultSet,JdbcColumnKey> getterFactory)` Override the default implementation of the GetterFactory used to get access to value from the ResultSet.
`JdbcMapperFactory`	`ignorePropertyNotFound()` Change the mapperBuilderErrorHandler to an IgnoreMapperBuilderErrorHandler.
`JdbcMapperFactory`	`mapperBuilderErrorHandler(MapperBuilderErrorHandler mapperBuilderErrorHandler)` Set the new MapperBuilderErrorHandler.
`<T> JdbcMapperBuilder<T>`	`newBuilder(Class<T> target)` Will create a instance of JdbcMapperBuilder on the specified target class.
`<T> JdbcMapperBuilder<T>`	`newBuilder(Type target)` Will create a instance of JdbcMapperBuilder on the specified type.
`<T> JdbcMapperBuilder<T>`	`newBuilder(TypeReference<T> target)` Will create a instance of JdbcMapperBuilder on the type T specified by the typeReference.
`<T> DiscriminatorJdbcBuilder<T>`	`newDiscriminator(String column)` Create a discriminator builder based on the specified column
`static JdbcMapperFactory`	`newInstance()` instantiate a new JdbcMapperFactory
`<T> JdbcMapper<T>`	`newMapper(Class<T> target)` Will create a DynamicMapper on the specified target class.
`<T> JdbcMapper<T>`	`newMapper(Class<T> target, ResultSetMetaData metaData)` Will create a instance of JdbcMapper based on the specified metadata and the target class.
`<T> JdbcMapper<T>`	`newMapper(Type target)` Will create a DynamicMapper on the specified type.
`<T> JdbcMapper<T>`	`newMapper(TypeReference<T> target)` Will create a DynamicMapper on the type specified by the TypeReference.
`JdbcMapperFactory`	`propertyNameMatcherFactory(PropertyNameMatcherFactory propertyNameMatcherFactory)` Override the default PropertyNameMatcherFactory with the specified factory.
`JdbcMapperFactory`	`reflectionService(ReflectionService reflectionService)` Override the default implementation of the ReflectionService.
`RowHandlerErrorHandler`	`rowHandlerErrorHandler()`
`JdbcMapperFactory`	`rowHandlerErrorHandler(RowHandlerErrorHandler rowHandlerErrorHandler)` the RowHandlerErrorHandler is called when an exception is thrown by the RowHandler in the forEach call.
`JdbcMapperFactory`	`useAsm(boolean useAsm)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newInstance
```
public static JdbcMapperFactory newInstance()
```
    instantiate a new JdbcMapperFactory
    
    Returns:
    
    a new instance JdbcMapperFactory
  - fieldMapperErrorHandler
```
public JdbcMapperFactory fieldMapperErrorHandler(FieldMapperErrorHandler<JdbcColumnKey> fieldMapperErrorHandler)
```
    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:
    
    fieldMapperErrorHandler - the new FieldMapperErrorHandler
    
    Returns:
    
    the current factory
  - ignorePropertyNotFound
```
public JdbcMapperFactory ignorePropertyNotFound()
```
    Change the mapperBuilderErrorHandler to an IgnoreMapperBuilderErrorHandler.
    
    Returns:
    
    the current factory
  - mapperBuilderErrorHandler
```
public JdbcMapperFactory mapperBuilderErrorHandler(MapperBuilderErrorHandler mapperBuilderErrorHandler)
```
    Set the new MapperBuilderErrorHandler. the MapperBuilderErrorHandler is called when an error occurred or a property is not found in the builder while creating the mapper.
    
    Parameters:
    
    mapperBuilderErrorHandler - the MapperBuilderErrorHandler
    
    Returns:
    
    the current factory
  - rowHandlerErrorHandler
```
public JdbcMapperFactory rowHandlerErrorHandler(RowHandlerErrorHandler rowHandlerErrorHandler)
```
    the RowHandlerErrorHandler is called when an exception is thrown by the RowHandler in the forEach call.
    
    Parameters:
    
    rowHandlerErrorHandler - the new RowHandlerErrorHandler
    
    Returns:
    
    the current factory
  - useAsm
```
public JdbcMapperFactory useAsm(boolean useAsm)
```
    Parameters:
    
    useAsm - false if you want to disable asm generation of Mappers, Getter and Setter. This would be active by default if asm is present in a compatible version.
    
    Returns:
    
    the current factory
  - disableAsm
```
public JdbcMapperFactory disableAsm(boolean disableAsm)
```
    Parameters:
    
    disableAsm - true if you want to disable asm for generation and to resolve constructor parameter names.
    
    Returns:
    
    the current factory
  - getterFactory
```
public JdbcMapperFactory getterFactory(GetterFactory<ResultSet,JdbcColumnKey> getterFactory)
```
    Override the default implementation of the GetterFactory used to get access to value from the ResultSet.
    
    Parameters:
    
    getterFactory - the getterFactory
    
    Returns:
    
    the current factory
  - reflectionService
```
public JdbcMapperFactory reflectionService(ReflectionService reflectionService)
```
    Override the default implementation of the ReflectionService.
    
    Parameters:
    
    reflectionService - the overriding instance
    
    Returns:
    
    the current factory
  - newMapper
```
public <T> JdbcMapper<T> newMapper(Class<T> target,
                                   ResultSetMetaData metaData)
                            throws SQLException
```
    Will create a instance of JdbcMapper based on the specified metadata and the target class.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the target class of the mapper
    
    metaData - the metadata to create the mapper from
    
    Returns:
    
    a mapper that will map the data represented by the metadata to an instance of target
    
    Throws:
    
    SQLException - if an error occurs getting the metaData
  - newBuilder
```
public <T> JdbcMapperBuilder<T> newBuilder(Class<T> target)
```
    Will create a instance of JdbcMapperBuilder on the specified target class.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the target class
    
    Returns:
    
    the builder
  - newBuilder
```
public <T> JdbcMapperBuilder<T> newBuilder(TypeReference<T> target)
```
    Will create a instance of JdbcMapperBuilder on the type T specified by the typeReference.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the typeReference
    
    Returns:
    
    the builder
  - newBuilder
```
public <T> JdbcMapperBuilder<T> newBuilder(Type target)
```
    Will create a instance of JdbcMapperBuilder on the specified type.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the type
    
    Returns:
    
    the builder
  - newMapper
```
public <T> JdbcMapper<T> newMapper(Class<T> target)
```
    Will create a DynamicMapper on the specified target class.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the class
    
    Returns:
    
    the DynamicMapper
  - newMapper
```
public <T> JdbcMapper<T> newMapper(TypeReference<T> target)
```
    Will create a DynamicMapper on the type specified by the TypeReference.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the TypeReference
    
    Returns:
    
    the DynamicMapper
  - newMapper
```
public <T> JdbcMapper<T> newMapper(Type target)
```
    Will create a DynamicMapper on the specified type.
    
    Type Parameters:
    
    T - the mapper target type
    
    Parameters:
    
    target - the type
    
    Returns:
    
    the DynamicMapper
  - addAlias
```
public JdbcMapperFactory addAlias(String key,
                                  String value)
```
    Associate an alias on the column key to rename to value.
    
    Parameters:
    
    key - the column to rename
    
    value - then name to rename to
    
    Returns:
    
    the current factory
  - addCustomFieldMapper
```
public JdbcMapperFactory addCustomFieldMapper(String key,
                                              FieldMapper<ResultSet,?> fieldMapper)
```
    Associate the specified FieldMapper for the specified column.
    
    Parameters:
    
    key - the column
    
    fieldMapper - the fieldMapper
    
    Returns:
    
    the current factory
  - addCustomGetter
```
public JdbcMapperFactory addCustomGetter(String key,
                                         Getter<ResultSet,?> getter)
```
    Associate the specified Getter for the specified column.
    
    Parameters:
    
    key - the column
    
    getter - the getter
    
    Returns:
    
    the current factory
  - addColumnDefinition
```
public JdbcMapperFactory addColumnDefinition(String key,
                                             FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)
```
    Associate the specified columnDefinition to the specified column.
    
    Parameters:
    
    key - the column
    
    columnDefinition - the columnDefinition
    
    Returns:
    
    the current factory
  - addColumnDefinition
```
public JdbcMapperFactory addColumnDefinition(Predicate<? super JdbcColumnKey> predicate,
                                             FieldMapperColumnDefinition<JdbcColumnKey,ResultSet> columnDefinition)
```
    Associate the specified columnDefinition to the column matching the predicate.
    
    Parameters:
    
    predicate - the column predicate
    
    columnDefinition - the columnDefinition
    
    Returns:
    
    the current factory
  - propertyNameMatcherFactory
```
public JdbcMapperFactory propertyNameMatcherFactory(PropertyNameMatcherFactory propertyNameMatcherFactory)
```
    Override the default PropertyNameMatcherFactory with the specified factory.
    
    Parameters:
    
    propertyNameMatcherFactory - the factory
    
    Returns:
    
    the current factory
  - addAliases
```
public JdbcMapperFactory addAliases(Map<String,String> aliases)
```
    Associate the aliases value to the column key.
    
    Parameters:
    
    aliases - the key value pair
    
    Returns:
    
    the current factory
  - failOnAsm
```
public JdbcMapperFactory failOnAsm(boolean b)
```
    Parameters:
    
    b - true if we want the builder to fail on asm generation failure
    
    Returns:
    
    the current factory
  - asmMapperNbFieldsLimit
```
public JdbcMapperFactory asmMapperNbFieldsLimit(int asmMapperNbFieldsLimit)
```
    change the number of fields threshold after which an asm mapper is not generated.
    the default value is calculated from the benchmark results, currently 240.
    
    Parameters:
    
    asmMapperNbFieldsLimit - the limit after which it does not use asm for the mapper.
    
    Returns:
    
    the factory
  - addKeys
```
public JdbcMapperFactory addKeys(String... columns)
```
    Mark the specified columns as keys.
    
    Parameters:
    
    columns - the columns
    
    Returns:
    
    the current factory
  - newDiscriminator
```
public <T> DiscriminatorJdbcBuilder<T> newDiscriminator(String column)
```
    Create a discriminator builder based on the specified column
    
    Type Parameters:
    
    T - the root type of the mapper
    
    Parameters:
    
    column - the discriminator column
    
    Returns:
    
    a builder to specify the type mapping
  - rowHandlerErrorHandler
```
public RowHandlerErrorHandler rowHandlerErrorHandler()
```
    Returns:
    
    the current RowHandlerErrorHandler

Class JdbcMapperFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newInstance

fieldMapperErrorHandler

ignorePropertyNotFound

mapperBuilderErrorHandler

rowHandlerErrorHandler

useAsm

disableAsm

getterFactory

reflectionService

newMapper

newBuilder

newBuilder

newBuilder

newMapper

newMapper

newMapper

addAlias

addCustomFieldMapper

addCustomGetter

addColumnDefinition

addColumnDefinition

propertyNameMatcherFactory

addAliases

failOnAsm

asmMapperNbFieldsLimit

addKeys

newDiscriminator

rowHandlerErrorHandler