org.josef.util.csv

Class AbstractCsvMemoryWriter

java.lang.Object

org.josef.util.csv.AbstractCsv

org.josef.util.csv.AbstractCsvWriter

org.josef.util.csv.AbstractCsvMemoryWriter

All Implemented Interfaces:

Serializable

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

Abstract Utility class to write CSV (Comma Separated Values) output to memory.
This class allows you to create csv output and store the result in a session for example, where a servlet can find it and show the information.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCsvMemoryWriter() Creates this AbstractCsvMemoryWriter.
AbstractCsvMemoryWriter(Character columnSeparator) Constructs this AbstractCsvMemoryWriter that will use the supplied columnSeparator as a column separator.

Method Summary

Modifier and Type	Method and Description
List<String>	getRows() Gets the csv rows.
void	writeCsvData() Writes all the rows returned by AbstractCsv.getNextRow() to memory.
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

AbstractCsvMemoryWriter

public AbstractCsvMemoryWriter()

Creates this AbstractCsvMemoryWriter.
By default this writer uses a comma as a column separator.

AbstractCsvMemoryWriter

public AbstractCsvMemoryWriter(Character columnSeparator)

Constructs this AbstractCsvMemoryWriter that will use the supplied columnSeparator as a column separator.

Parameters:

columnSeparator - The separator that separates the different columns.

Throws:

NullPointerException - When the supplied columnSeparator is null.

Method Detail

getRows

public List<String> getRows()

Gets the csv rows.
Each element in the returned list contains a single line of csv output.

Returns:

The csv storage (which is a list of csv rows).

writeCsvData

public void writeCsvData()

Writes all the rows returned by AbstractCsv.getNextRow() to memory.

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!