org.josef.util.csv

Class AbstractCsvWriter

java.lang.Object

org.josef.util.csv.AbstractCsv

org.josef.util.csv.AbstractCsvWriter

Direct Known Subclasses:

AbstractCsvFileWriter, AbstractCsvMemoryWriter

@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 AbstractCsvWriter
extends AbstractCsv

Abstract base class for Utility classes that write CSV (Comma Separated Values) output.
The csv output format normally consists of:
- an optional header row that describes all columns.
- one or more data rows consisting of several columns.
For both the header row and the data rows it is true that every individual column is separated with a column separator like a comma and every row is separated with a row separator like '\\n'.

Version:

1.0 $Revision: 3753 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCsvWriter() Default constructor that will use a comma as the column separator and the platform's line.separator as a row separator.
	AbstractCsvWriter(Character columnSeparator) Constructs this AbstractCsvWriter that will use the supplied columnSeparator as a column separator and the platform's line.separator as a row separator.
	AbstractCsvWriter(Character columnSeparator, String rowSeparator) Constructs this AbstractCsvWriter that will use the supplied columnSeparator as a column separator and the supplied rowSeparator as a row separator.

Method Summary

Modifier and Type	Method and Description
abstract boolean	hasNextRow() Determines whether a next row of csv data exists.
abstract void	writeCsvData() Writes all of the csv data.
abstract void	writeRow(String row) Writes a single row of csv data.

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

AbstractCsvWriter

protected AbstractCsvWriter()

Default constructor that will use a comma as the column separator and the platform's line.separator as a row separator.

AbstractCsvWriter

public AbstractCsvWriter(Character columnSeparator)

Constructs this AbstractCsvWriter that will use the supplied columnSeparator as a column separator and the platform's line.separator as a row separator.

Parameters:

columnSeparator - The separator that separates the different columns.

Throws:

NullPointerException - When the supplied columnSeparator is null.

AbstractCsvWriter

public AbstractCsvWriter(Character columnSeparator,
                         String rowSeparator)

Constructs this AbstractCsvWriter that will use the supplied columnSeparator as a column separator and the supplied rowSeparator as a row separator.

Parameters:

columnSeparator - The separator that separates the different columns.

rowSeparator - The separator that separates the different rows.

Throws:

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

Method Detail

writeCsvData

public abstract void writeCsvData()

Writes all of the csv data.
Normally subclasses will provide a concrete implementation, building upon the methods: hasNextRow() and AbstractCsv.getNextRow().

Throws:

CsvException - When the csv data could not be written.

hasNextRow

public abstract boolean hasNextRow()

Determines whether a next row of csv data exists.

Returns:

True when another rows exist, otherwise false.

writeRow

public abstract void writeRow(String row)

Writes a single row of csv data.

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!

Throws:

NullPointerException - When the supplied row is null.

CsvException - When the csv data could not be written.