org.sfm.csv

Class CsvMapperFactory

java.lang.Object

org.sfm.csv.CsvMapperFactory

public final class CsvMapperFactory
extends Object

CsvMapperFactory 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 first line of the csv file to figure out the list of the columns or a static one using a builder.

// create a dynamic mapper targeting MyClass
CsvMapperFactory
.newInstance()
.newMapper(MyClass.class);

// create a static mapper targeting MyClass
CsvMapperFactory
.newInstance()
.newBuilder(MyClass.class)
.addMapping("id")
.addMapping("field1")
.addMapping("field2")
.mapper();



Constructor Summary

Constructors

Constructor and Description
CsvMapperFactory()

Method Summary

Modifier and Type	Method and Description
CsvMapperFactory	addAlias(String key, String value)
CsvMapperFactory	addColumnDefinition(Predicate<? super CsvColumnKey> predicate, CsvColumnDefinition columnDefinition)
CsvMapperFactory	addColumnDefinition(String key, CsvColumnDefinition columnDefinition)
CsvMapperFactory	addCustomValueReader(String key, CellValueReader<?> cellValueReader)
CsvMapperFactory	addKeys(String... columns)
CsvMapperFactory	asmMapperNbFieldsLimit(int asmMapperNbFieldsLimit) change the number of fields threshold after which an asm mapper is not generated.
CsvMapperFactory	cellValueReaderFactory(CellValueReaderFactory cellValueReaderFactory)
CsvMapperFactory	defaultDateFormat(String defaultDateFormat)
CsvMapperFactory	disableAsm(boolean disableAsm)
CsvMapperFactory	failOnAsm(boolean failOnAsm)
CsvMapperFactory	fieldMapperErrorHandler(FieldMapperErrorHandler<CsvColumnKey> fieldMapperErrorHandler) Set a new FieldMapperErrorHandler.
CsvMapperFactory	mapperBuilderErrorHandler(MapperBuilderErrorHandler mapperBuilderErrorHandler) Set a new MapperBuilderErrorHandler.
CsvMapperFactory	maxMethodSize(int maxMethodSize) Number needs to be a power of 2, do not use if you don't know what it does.
<T> CsvMapperBuilder<T>	newBuilder(Class<T> target) Will create a instance of ResultSetMapperBuilder
<T> CsvMapperBuilder<T>	newBuilder(Type target)
<T> CsvMapperBuilder<T>	newBuilder(TypeReference<T> target)
static CsvMapperFactory	newInstance() instantiate a new JdbcMapperFactory
<T> CsvMapper<T>	newMapper(Class<T> target)
<T> CsvMapper<T>	newMapper(Type target)
<T> CsvMapper<T>	newMapper(TypeReference<T> target)
CsvMapperFactory	propertyNameMatcherFactory(PropertyNameMatcherFactory propertyNameMatcherFactory)
CsvMapperFactory	rowHandlerErrorHandler(RowHandlerErrorHandler rowHandlerErrorHandler) Set a new RowHandlerErrorHandler.
CsvMapperFactory	useAsm(boolean useAsm)

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvMapperFactory

public CsvMapperFactory()

Method Detail

newInstance

public static CsvMapperFactory newInstance()

instantiate a new JdbcMapperFactory

Returns:

a new JdbcMapperFactory

fieldMapperErrorHandler

public CsvMapperFactory fieldMapperErrorHandler(FieldMapperErrorHandler<CsvColumnKey> fieldMapperErrorHandler)

Set a new FieldMapperErrorHandler. Use to handle thrown during the mapping of a field.

Parameters:

fieldMapperErrorHandler - the FieldMapperErrorHandler

Returns:

the current factory

mapperBuilderErrorHandler

public CsvMapperFactory mapperBuilderErrorHandler(MapperBuilderErrorHandler mapperBuilderErrorHandler)

Set a new MapperBuilderErrorHandler. Use to handle to handle Mapper builder error when reading the header.

Parameters:

mapperBuilderErrorHandler - the MapperBuilderErrorHandler

Returns:

the current factory

rowHandlerErrorHandler

public CsvMapperFactory rowHandlerErrorHandler(RowHandlerErrorHandler rowHandlerErrorHandler)

Set a new RowHandlerErrorHandler. Use to handle error thrown by the RowHandler on the forEach call.

Parameters:

rowHandlerErrorHandler - the RowHandlerErrorHandler

Returns:

the current factory

useAsm

public CsvMapperFactory useAsm(boolean useAsm)

Parameters:

useAsm - false if you want to disable asm usage.

Returns:

the factory

failOnAsm

public CsvMapperFactory failOnAsm(boolean failOnAsm)

Parameters:

failOnAsm - true if don't want to recover from an asm generation failure of the mapper

Returns:

the factory

asmMapperNbFieldsLimit

public CsvMapperFactory 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

maxMethodSize

public CsvMapperFactory maxMethodSize(int maxMethodSize)

Number needs to be a power of 2, do not use if you don't know what it does.

Parameters:

maxMethodSize - the max method size, needs be a power of 2.

Returns:

the factory.

disableAsm

public CsvMapperFactory disableAsm(boolean disableAsm)

Parameters:

disableAsm - true if you want to disable asm.

Returns:

the current factory

defaultDateFormat

public CsvMapperFactory defaultDateFormat(String defaultDateFormat)

cellValueReaderFactory

public CsvMapperFactory cellValueReaderFactory(CellValueReaderFactory cellValueReaderFactory)

newMapper

public <T> CsvMapper<T> newMapper(Class<T> target)
                           throws MapperBuildingException

Type Parameters:

T - the targeted type

Parameters:

target - the targeted class for the mapper

Returns:

a jdbc mapper that will map to the targeted class.

Throws:

MapperBuildingException - if an error occurs building the mapper

newMapper

public <T> CsvMapper<T> newMapper(TypeReference<T> target)
                           throws MapperBuildingException

Throws:

MapperBuildingException

newMapper

public <T> CsvMapper<T> newMapper(Type target)
                           throws MapperBuildingException

Throws:

MapperBuildingException

newBuilder

public <T> CsvMapperBuilder<T> newBuilder(Class<T> target)

Will create a instance of ResultSetMapperBuilder

Type Parameters:

T - the targeted type

Parameters:

target - the target class of the mapper

Returns:

a builder ready to instantiate a mapper or to be customized

Throws:

MapperBuildingException - if an error occurs building the mapper

newBuilder

public <T> CsvMapperBuilder<T> newBuilder(TypeReference<T> target)

newBuilder

public <T> CsvMapperBuilder<T> newBuilder(Type target)

addAlias

public CsvMapperFactory addAlias(String key,
                                 String value)

addCustomValueReader

public CsvMapperFactory addCustomValueReader(String key,
                                             CellValueReader<?> cellValueReader)

propertyNameMatcherFactory

public CsvMapperFactory propertyNameMatcherFactory(PropertyNameMatcherFactory propertyNameMatcherFactory)

addColumnDefinition

public CsvMapperFactory addColumnDefinition(String key,
                                            CsvColumnDefinition columnDefinition)

addColumnDefinition

public CsvMapperFactory addColumnDefinition(Predicate<? super CsvColumnKey> predicate,
                                            CsvColumnDefinition columnDefinition)

addKeys

public CsvMapperFactory addKeys(String... columns)