org.supercsv.io.dozer

Interface ICsvDozerBeanReader

All Superinterfaces:

AutoCloseable, Closeable, ICsvReader

All Known Implementing Classes:

CsvDozerBeanReader

public interface ICsvDozerBeanReader
extends ICsvReader

Interface for CSV readers reading into objects/beans using Dozer.

Since:

2.0.0

Author:

James Bassett

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 interface org.supercsv.io.ICsvReader

get, getHeader, getLineNumber, getRowNumber, getUntokenizedRow, length

Methods inherited from interface java.io.Closeable

close

Method Detail

configureBeanMapping

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.

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)

Throws:

NullPointerException - if clazz or fieldMapping is null

Since:

2.0.0

configureBeanMapping

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.

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

Throws:

NullPointerException - if clazz, fieldMapping, or hintTypes is null

IllegalArgumentException - if fieldMapping.length != hintTypes.length

Since:

2.1.0

read

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

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

MappingException - if there was an exception during Dozer mapping

NullPointerException - if clazz is null

SuperCsvException - if there was a general exception while reading/processing

Since:

2.0.0

read

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

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

MappingException - if there was an exception during Dozer mapping

NullPointerException - if bean is null

SuperCsvException - if there was a general exception while reading/processing

Since:

2.2.0

read

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

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

MappingException - if there was an exception during Dozer mapping

NullPointerException - if clazz is null

SuperCsvException - if there was a general exception while reading/processing

Since:

2.0.0

read

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

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

MappingException - if there was an exception during Dozer mapping

NullPointerException - if bean is null

SuperCsvException - if there was a general exception while reading/processing

Since:

2.2.0