org.supercsv.io.dozer

Class CsvDozerBeanWriter

java.lang.Object

org.supercsv.io.AbstractCsvWriter

org.supercsv.io.dozer.CsvDozerBeanWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ICsvDozerBeanWriter, ICsvWriter

public class CsvDozerBeanWriter
extends AbstractCsvWriter
implements ICsvDozerBeanWriter

CsvDozerBeanWriter is a powerful replacement for CsvBeanWriter that uses Dozer to map from a bean to CSV.

Since:

2.0.0

Author:

James Bassett

Constructor Summary

Constructors

Constructor and Description
CsvDozerBeanWriter(Writer writer, CsvPreference preference) Constructs a new CsvDozerBeanWriter with the supplied Writer and CSV preferences and and creates it's own DozerBeanMapper.
CsvDozerBeanWriter(Writer writer, CsvPreference preference, DozerBeanMapper dozerBeanMapper) Constructs a new CsvDozerBeanWriter with the supplied Writer, 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 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 class org.supercsv.io.AbstractCsvWriter

close, flush, getLineNumber, getRowNumber, incrementRowAndLineNo, writeComment, writeHeader, writeRow, writeRow, writeRow

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

getLineNumber, getRowNumber, writeComment, writeHeader

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Constructor Detail

CsvDozerBeanWriter

public CsvDozerBeanWriter(Writer writer,
                          CsvPreference preference)

Constructs a new CsvDozerBeanWriter with the supplied Writer and CSV preferences and and creates it's own DozerBeanMapper. Note that the writer will be wrapped in a BufferedWriter before accessed.

Parameters:

writer - the writer

preference - the CSV preferences

Throws:

NullPointerException - if writer or preference are null

CsvDozerBeanWriter

public CsvDozerBeanWriter(Writer writer,
                          CsvPreference preference,
                          DozerBeanMapper dozerBeanMapper)

Constructs a new CsvDozerBeanWriter with the supplied Writer, CSV preferences and DozerBeanMapper. Note that the writer will be wrapped in a BufferedWriter before accessed.

Parameters:

writer - the writer

preference - the CSV preferences

dozerBeanMapper - the pre-configured DozerBeanMapper

Throws:

NullPointerException - if writer, preference 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 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.

Specified by:

configureBeanMapping in interface ICsvDozerBeanWriter

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)

write

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

Specified by:

write in interface ICsvDozerBeanWriter

Parameters:

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

Throws:

IOException - if an I/O error occurred

write

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

Specified by:

write in interface ICsvDozerBeanWriter

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