org.josef.util.csv

Class AbstractCsvFileWriter

java.lang.Object

org.josef.util.csv.AbstractCsv

org.josef.util.csv.AbstractCsvWriter

org.josef.util.csv.AbstractCsvFileWriter

@Status(stage=DEVELOPMENT,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",at="2009-09-28") @Review(by="Kees Schotanus",at="2010-10-22",reason="Totally rewrote csv classes")
public abstract class AbstractCsvFileWriter
extends AbstractCsvWriter

Abstract Utility class to write CSV (Comma Separated Values) output to a File.
To create a concrete subclass, simply extend this class and implement the methods: AbstractCsvWriter.hasNextRow() and AbstractCsv.getNextRow().

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
AbstractCsvFileWriter(File file) Constructs this AbstractCsvFileWriter that will write csv data to the supplied file.
AbstractCsvFileWriter(File file, Character columnSeparator) Constructs this AbstractCsvFileWriter that will write csv data to the supplied file and will use the supplied columnSeparator as a column separator.
AbstractCsvFileWriter(File file, Character columnSeparator, String rowSeparator) Constructs this AbstractCsvFileWriter that will write csv data to the supplied file and will use the supplied columnSeparator as a column separator and the supplied rowSeparator to separate the rows.

Method Summary

Modifier and Type	Method and Description
void	writeCsvData() Writes all the rows returned by AbstractCsv.getNextRow() to the file specified at construction time.
void	writeRow(String row) Writes a single row of csv data.

Methods inherited from class org.josef.util.csv.AbstractCsvWriter

hasNextRow

Methods inherited from class org.josef.util.csv.AbstractCsv

getColumnSeparator, getNextRow, getRowSeparator, setColumnSeparator, setRowSeparator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCsvFileWriter

public AbstractCsvFileWriter(File file)

Constructs this AbstractCsvFileWriter that will write csv data to the supplied file.
By default a comma is used as the column separator and the platform's line.separator is used to separate the rows.

Parameters:

file - The file to write the csv data to.

Throws:

NullPointerException - When the supplied file is null.

AbstractCsvFileWriter

public AbstractCsvFileWriter(File file,
                             Character columnSeparator)

Constructs this AbstractCsvFileWriter that will write csv data to the supplied file and will use the supplied columnSeparator as a column separator.
By default, the platform's line.separator is used to separate the rows.

Parameters:

file - The file to write the csv data to.

columnSeparator - The separator that separates the different columns.

Throws:

NullPointerException - When either the supplied file or columnSeparator is null.

AbstractCsvFileWriter

public AbstractCsvFileWriter(File file,
                             Character columnSeparator,
                             String rowSeparator)

Constructs this AbstractCsvFileWriter that will write csv data to the supplied file and will use the supplied columnSeparator as a column separator and the supplied rowSeparator to separate the rows.

Parameters:

file - The file to write the csv data to.

columnSeparator - The separator that separates the different columns.

rowSeparator - The separator that separates the different rows.
You normally don't want to supply a rowSeparator other than the default line separator for the platform running this code, at the risk of not being able to read that data on the same platform.

Throws:

NullPointerException - When either the supplied file, columnSeparator or rowSeparator is null.

Method Detail

writeCsvData

public void writeCsvData()

Writes all the rows returned by AbstractCsv.getNextRow() to the file specified at construction time.

Specified by:

writeCsvData in class AbstractCsvWriter

Throws:

CsvException - When the csv data could not be written.

writeRow

public void writeRow(String row)

Writes a single row of csv data.

Specified by:

writeRow in class AbstractCsvWriter

Parameters:

row - The row to write.
This should be a single String consisting of properly quoted columns, separated with a column separator. The row should not contain a row separator!