org.supercsv.io.dozer

Interface ICsvDozerBeanWriter

All Superinterfaces:

AutoCloseable, Closeable, Flushable, ICsvWriter

All Known Implementing Classes:

CsvDozerBeanWriter

public interface ICsvDozerBeanWriter
extends ICsvWriter

Interface for CSV writers writing objects/beans to CSV 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 specified class to the CSV file (this method may only be called before writing, as it's not possible to configure a DozerBeanMapper that has already been initialized).
void	write(Object source) Writes the fields of the object as columns of a CSV file, using the pre-configured DozerBeanMapper to map fields to the appropriate columns.
void	write(Object source, CellProcessor[] processors) Writes the fields of the object as columns of a CSV file, using the pre-configured DozerBeanMapper to map fields to the appropriate columns.

Methods inherited from interface org.supercsv.io.ICsvWriter

getLineNumber, getRowNumber, writeComment, writeHeader

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Method Detail

configureBeanMapping

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

Configures the underlying DozerBeanMapper with the mappings required to map from the specified class to the CSV file (this method may only be called before writing, 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 written 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 (cannot contain null elements)

Throws:

NullPointerException - if clazz or fieldMapping (or one of its elements) is null

Since:

2.0.0

write

void write(Object source)
    throws IOException

Writes the fields of the object as columns of a CSV file, using the pre-configured DozerBeanMapper to map fields to the appropriate columns. toString() will be called on each element prior to writing.

Parameters:

source - the object (bean instance) containing the values to write

Throws:

IOException - if an I/O error occurred

MappingException - if there was an exception during Dozer mapping

NullPointerException - if source is null

SuperCsvException - if there was a general exception while writing

Since:

2.0.0

write

void write(Object source,
           CellProcessor[] processors)
    throws IOException

Writes the fields of the object as columns of a CSV file, using the pre-configured DozerBeanMapper to map fields to the appropriate columns.

Before writing, 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 value returned by toString() will be written as the column value). toString() will be called on each (processed) element prior to writing.

Parameters:

source - the object (bean instance) containing the values to write

processors - an array of CellProcessors used to further process data before it is written (each element in the processors array corresponds with a CSV column - the number of processors should match the number of columns). A null entry indicates no further processing is required (the value returned by toString() will be written as the column value).

Throws:

IOException - if an I/O error occurred

MappingException - if there was an exception during Dozer mapping

NullPointerException - if source, nameMapping or processors are null

SuperCsvConstraintViolationException - if a CellProcessor constraint failed

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

Since:

2.0.0