org.josef.util.csv

Class CsvFileReader

java.lang.Object

org.josef.util.csv.AbstractCsv

org.josef.util.csv.AbstractCsvReader

org.josef.util.csv.CsvFileReader

@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") @Review(by="Kees Schotanus",at="2013-10-09",reason="Maarten van Steenbergen suggested to add a Charset")
public class CsvFileReader
extends AbstractCsvReader

Utility class to read csv (Comma Separated Values) input from a File.

Version:

1.0 $Revision: 6298 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
CsvFileReader(File file) Constructs this CsvFileReader that will read csv data from the supplied file, using a comma as the column separator and the default character set (for the platform running the application).
CsvFileReader(File file, Character columnSeparator) Constructs this CsvFileReader that will read csv data from the supplied file, using the supplied columnSeparator as a column separator and the default character set (for the platform running the application).
CsvFileReader(File file, Character columnSeparator, Charset characterSet) Constructs this CsvFileReader that will read csv data from the supplied file, using the supplied columnSeparator as a column separator and the supplied characterSet.

Method Summary

Modifier and Type	Method and Description
void	close() Closes used resources.
protected void	finalize() Closes resources in case the programmer did not read all rows and forgot to call the close method! A message of level Level.ERROR is logged when this is the case.
String[]	getNextRow() Gets the next row of columns.

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

getColumnSeparator, getRowSeparator, setColumnSeparator, setRowSeparator

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvFileReader

public CsvFileReader(File file)

Constructs this CsvFileReader that will read csv data from the supplied file, using a comma as the column separator and the default character set (for the platform running the application).

Parameters:

file - The file to read the csv data from.

Throws:

NullPointerException - When the supplied file is null.

CsvException - When the supplied file could not be opened.

CsvFileReader

public CsvFileReader(File file,
                     Character columnSeparator)

Constructs this CsvFileReader that will read csv data from the supplied file, using the supplied columnSeparator as a column separator and the default character set (for the platform running the application).

Parameters:

file - The file to read the csv data from.

columnSeparator - The separator that separates the different columns.

Throws:

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

CsvException - When the supplied file could not be opened.

CsvFileReader

public CsvFileReader(File file,
                     Character columnSeparator,
                     Charset characterSet)

Constructs this CsvFileReader that will read csv data from the supplied file, using the supplied columnSeparator as a column separator and the supplied characterSet.

Parameters:

file - The file to read the csv data from.

columnSeparator - The separator that separates the different columns.

characterSet - The characterSet used for decoding.

Throws:

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

CsvException - When the supplied file could not be opened.

Method Detail

getNextRow

public String[] getNextRow()

Gets the next row of columns.

Specified by:

getNextRow in class AbstractCsv

Returns:

The next row of columns or null when no more rows exist.

close

public void close()

Closes used resources.
When all rows have been read using getNextRow(), then there is no need to call this method. In all other cases, calling this method is a must.

finalize

protected void finalize()
                 throws Throwable

Closes resources in case the programmer did not read all rows and forgot to call the close method!
A message of level Level.ERROR is logged when this is the case.

Overrides:

finalize in class Object

Throws:

Throwable - Thrown by the finalizer of the super class.