org.supercsv.io.dozer

Class CsvDozerBeanReader

java.lang.Object

org.supercsv.io.AbstractCsvReader

org.supercsv.io.dozer.CsvDozerBeanReader

All Implemented Interfaces:

Closeable, AutoCloseable, ICsvDozerBeanReader, ICsvReader

public class CsvDozerBeanReader
extends AbstractCsvReader
implements ICsvDozerBeanReader

CsvDozerBeanReader is a powerful replacement for CsvBeanReader that uses Dozer to map from CSV to a bean.

Since:

2.0.0

Author:

James Bassett

Constructor Summary

Constructors

Constructor and Description
CsvDozerBeanReader(ITokenizer tokenizer, CsvPreference preferences) Constructs a new CsvDozerBeanReader with the supplied (custom) Tokenizer and CSV preferences and creates it's own DozerBeanMapper.
CsvDozerBeanReader(ITokenizer tokenizer, CsvPreference preferences, DozerBeanMapper dozerBeanMapper) Constructs a new CsvDozerBeanReader with the supplied (custom) Tokenizer, CSV preferences and DozerBeanMapper.
CsvDozerBeanReader(Reader reader, CsvPreference preferences) Constructs a new CsvDozerBeanReader with the supplied Reader and CSV preferences and creates it's own DozerBeanMapper.
CsvDozerBeanReader(Reader reader, CsvPreference preferences, DozerBeanMapper dozerBeanMapper) Constructs a new CsvDozerBeanReader with the supplied Reader, CSV preferences and DozerBeanMapper.

Method Summary

Modifier and Type	Method and Description
void	configureBeanMapping(Class<?> clazz, String[] fieldMapping) Configures the underlying DozerBeanMapper with the mappings required to map from the CSV file to the specified class (this method may only be called before reading, as it's not possible to configure a DozerBeanMapper that has already been initialized).
void	configureBeanMapping(Class<?> clazz, String[] fieldMapping, Class<?>[] hintTypes) Configures the underlying DozerBeanMapper with the mappings required to map from the CSV file to the specified class (this method may only be called before reading, as it's not possible to configure a DozerBeanMapper that has already been initialized).
<T> T	read(Class<T> clazz) Reads a row of a CSV file and populates an instance of the specified class, using Dozer to map column values to the appropriate fields.
<T> T	read(Class<T> clazz, CellProcessor... processors) Reads a row of a CSV file and populates an instance of the specified class, using Dozer to map column values to the appropriate fields.
<T> T	read(T bean) Reads a row of a CSV file and populates the supplied bean, using Dozer to map column values to the appropriate fields.
<T> T	read(T bean, CellProcessor... processors) Reads a row of a CSV file and populates the supplied bean, using Dozer to map column values to the appropriate fields.

Methods inherited from class org.supercsv.io.AbstractCsvReader

close, executeProcessors, get, getColumns, getHeader, getLineNumber, getPreferences, getRowNumber, getUntokenizedRow, length, readRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.supercsv.io.ICsvReader

get, getHeader, getLineNumber, getRowNumber, getUntokenizedRow, length

Methods inherited from interface java.io.Closeable

close

Constructor Detail

CsvDozerBeanReader

public CsvDozerBeanReader(Reader reader,
                          CsvPreference preferences)

Constructs a new CsvDozerBeanReader with the supplied Reader and CSV preferences and creates it's own DozerBeanMapper. Note that the reader will be wrapped in a BufferedReader before accessed.

Parameters:

reader - the reader

preferences - the CSV preferences

Throws:

NullPointerException - if reader or preferences are null

CsvDozerBeanReader

public CsvDozerBeanReader(ITokenizer tokenizer,
                          CsvPreference preferences)

Constructs a new CsvDozerBeanReader with the supplied (custom) Tokenizer and CSV preferences and creates it's own DozerBeanMapper. The tokenizer should be set up with the Reader (CSV input) and CsvPreference beforehand.

Parameters:

tokenizer - the tokenizer

preferences - the CSV preferences

Throws:

NullPointerException - if tokenizer or preferences are null

CsvDozerBeanReader

public CsvDozerBeanReader(Reader reader,
                          CsvPreference preferences,
                          DozerBeanMapper dozerBeanMapper)

Constructs a new CsvDozerBeanReader with the supplied Reader, CSV preferences and DozerBeanMapper. Note that the reader will be wrapped in a BufferedReader before accessed.

Parameters:

reader - the reader

preferences - the CSV preferences

dozerBeanMapper - the dozer bean mapper to use

Throws:

NullPointerException - if reader, preferences or dozerBeanMapper are null

CsvDozerBeanReader

public CsvDozerBeanReader(ITokenizer tokenizer,
                          CsvPreference preferences,
                          DozerBeanMapper dozerBeanMapper)

Constructs a new CsvDozerBeanReader with the supplied (custom) Tokenizer, CSV preferences and DozerBeanMapper. The tokenizer should be set up with the Reader (CSV input) and CsvPreference beforehand.

Parameters:

tokenizer - the tokenizer

preferences - the CSV preferences

dozerBeanMapper - the dozer bean mapper to use

Throws:

NullPointerException - if tokenizer, preferences or dozerBeanMapper are null

Method Detail

configureBeanMapping

public void configureBeanMapping(Class<?> clazz,
                                 String[] fieldMapping)

Configures the underlying DozerBeanMapper with the mappings required to map from the CSV file to the specified class (this method may only be called before reading, as it's not possible to configure a DozerBeanMapper that has already been initialized). Generally this method will only be called once, but it may called more times to add mappings for other classes (you can define mappings for two different subclasses for example, but if you define a mapping for the parent class then that will take precedence - inheritance mapping isn't supported).

Each element of the fieldMapping array represents a CSV column to be read and uses the standard Dozer field mapping syntax. For example, if you were configuring the mappings for Person class you might define firstName as the first element (just a simple field mapping), address.city as the second element (a nested - or deep - field mapping), and accounts[0].balance as the third element (index based mapping).

If you require access to the other features of Dozer in your mappings (customer getters/setters, bean factories, custom converters), then you should supply your own DozerBeanMapper to the Writer instead.

Specified by:

configureBeanMapping in interface ICsvDozerBeanReader

Parameters:

clazz - the class to add mapping configuration for (same as the type passed into write methods)

fieldMapping - the field mapping for for each column (may contain null elements to indicate ignored columns)

configureBeanMapping

public void configureBeanMapping(Class<?> clazz,
                                 String[] fieldMapping,
                                 Class<?>[] hintTypes)

Configures the underlying DozerBeanMapper with the mappings required to map from the CSV file to the specified class (this method may only be called before reading, as it's not possible to configure a DozerBeanMapper that has already been initialized). Generally this method will only be called once, but it may called more times to add mappings for other classes (you can define mappings for two different subclasses for example, but if you define a mapping for the parent class then that will take precedence - inheritance mapping isn't supported).

Each element of the fieldMapping array represents a CSV column to be read and uses the standard Dozer field mapping syntax. For example, if you were configuring the mappings for Person class you might define firstName as the first element (just a simple field mapping), address.city as the second element (a nested - or deep - field mapping), and accounts[0].balance as the third element (index based mapping).

If you are mapping to an indexed list element (e.g. accounts[0]) and using a cell processor to return a custom bean type (e.g. a ParseAccount processor that creates an Account bean), you will need to specify a hint for that column so Dozer can map that column.

If you require access to the other features of Dozer in your mappings (customer getters/setters, bean factories, custom converters), then you should supply your own DozerBeanMapper to the Writer instead.

Specified by:

configureBeanMapping in interface ICsvDozerBeanReader

Parameters:

clazz - the class to add mapping configuration for (same as the type passed into write methods)

fieldMapping - the field mapping for for each column (may contain null elements to indicate ignored columns)

hintTypes - an array of types used as hints for Dozer when mapping to an indexed list element (e.g. accounts[0]) - a null element indicates no hint is required for that column

read

public <T> T read(Class<T> clazz)
           throws IOException

Reads a row of a CSV file and populates an instance of the specified class, using Dozer to map column values to the appropriate fields.

Specified by:

read in interface ICsvDozerBeanReader

Type Parameters:

T - the bean type

Parameters:

clazz - the type to instantiate

Returns:

a populated bean or null if EOF

Throws:

IOException - if an I/O error occurred

read

public <T> T read(Class<T> clazz,
                  CellProcessor... processors)
           throws IOException

Reads a row of a CSV file and populates an instance of the specified class, using Dozer to map column values to the appropriate fields. Before population the data can be further processed by cell processors (each element in the processors array corresponds with a CSV column). A null entry in the processors array indicates no further processing is required (the unprocessed String value will be set on the bean's field) - though Dozer will attempt some conversions of it's own it the types don't match.

Specified by:

read in interface ICsvDozerBeanReader

Type Parameters:

T - the bean type

Parameters:

clazz - the type to instantiate

processors - the cell processors

Returns:

a populated bean or null if EOF

Throws:

IOException - if an I/O error occurred

read

public <T> T read(T bean)
           throws IOException

Reads a row of a CSV file and populates the supplied bean, using Dozer to map column values to the appropriate fields.

Specified by:

read in interface ICsvDozerBeanReader

Type Parameters:

T - the bean type

Parameters:

bean - the bean to populate

Returns:

a populated bean or null if EOF

Throws:

IOException - if an I/O error occurred

read

public <T> T read(T bean,
                  CellProcessor... processors)
           throws IOException

Reads a row of a CSV file and populates the supplied bean, using Dozer to map column values to the appropriate fields. Before population the data can be further processed by cell processors (each element in the processors array corresponds with a CSV column). A null entry in the processors array indicates no further processing is required (the unprocessed String value will be set on the bean's field) - though Dozer will attempt some conversions of it's own it the types don't match.

Specified by:

read in interface ICsvDozerBeanReader

Type Parameters:

T - the bean type

Parameters:

bean - the bean to populate

processors - the cell processors

Returns:

a populated bean or null if EOF

Throws:

IOException - if an I/O error occurred