Package org.openforis.commons.io.csv

Class CsvReader

java.lang.Object

org.openforis.commons.io.csv.CsvProcessor

org.openforis.commons.io.csv.CsvReader

All Implemented Interfaces:

Closeable, AutoCloseable, FlatDataStream

public class CsvReader
extends CsvProcessor
implements FlatDataStream, Closeable

Author:

G. Miceli, M. Togna, S. Ricci

Field Summary

Fields

Modifier and Type	Field	Description
static char	DEFAULT_QUOTE_CHARACTER
static char	DEFAULT_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CsvReader(File file)
CsvReader(File file, char separator, char quoteChar)
CsvReader(File file, String charsetName, char separator, char quoteChar)
CsvReader(Reader reader)	Deprecated. Call CsvReader(File) instead.
CsvReader(Reader reader, char separator, char quoteChar)	Deprecated. Call CsvReader(File, char, char) instead.
CsvReader(String filename)
CsvReader(String fileName, char separator, char quoteChar)

Method Summary

Modifier and Type	Method	Description
void	close()
List<String>	getColumnNames()
DateFormat	getDateFormat()
List<String>	getFieldNames()
List<Field>	getFields()
long	getLinesRead()
boolean	isHeadersRead()
FlatRecord	nextRecord()
void	readHeaders()
CsvLine	readNextLine()
void	setHeadersRead(boolean headersRead)
int	size()	Returns the number of lines including the headers

Methods inherited from class org.openforis.commons.io.csv.CsvProcessor

setDateFormat, setDateFormat, setFieldNames, setFields, setFields

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

See Also:

Constant Field Values

DEFAULT_QUOTE_CHARACTER

public static final char DEFAULT_QUOTE_CHARACTER

See Also:

Constant Field Values

Constructor Detail

CsvReader

public CsvReader(String filename)
          throws FileNotFoundException

Throws:

FileNotFoundException

CsvReader

public CsvReader(String fileName,
                 char separator,
                 char quoteChar)
          throws FileNotFoundException

Throws:

FileNotFoundException

CsvReader

public CsvReader(File file)
          throws FileNotFoundException

Throws:

FileNotFoundException

CsvReader

public CsvReader(File file,
                 char separator,
                 char quoteChar)
          throws FileNotFoundException

Throws:

FileNotFoundException

CsvReader

public CsvReader(File file,
                 String charsetName,
                 char separator,
                 char quoteChar)
          throws FileNotFoundException

Throws:

FileNotFoundException

CsvReader

@Deprecated
public CsvReader(Reader reader)

Deprecated.

Call CsvReader(File) instead.

CsvReader

@Deprecated
public CsvReader(Reader reader,
                 char separator,
                 char quoteChar)

Deprecated.

Call CsvReader(File, char, char) instead.

Method Detail

readHeaders

public void readHeaders()
                 throws IOException

Throws:

IOException

readNextLine

public CsvLine readNextLine()
                     throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isHeadersRead

public boolean isHeadersRead()

setHeadersRead

public void setHeadersRead(boolean headersRead)

getLinesRead

public long getLinesRead()

getFields

public List<Field> getFields()

Specified by:

getFields in interface FlatDataStream

Overrides:

getFields in class CsvProcessor

getFieldNames

public List<String> getFieldNames()

Overrides:

getFieldNames in class CsvProcessor

nextRecord

public FlatRecord nextRecord()
                      throws IOException

Specified by:

nextRecord in interface FlatDataStream

Throws:

IOException

getColumnNames

public List<String> getColumnNames()

getDateFormat

public DateFormat getDateFormat()

Overrides:

getDateFormat in class CsvProcessor

size

public int size()
         throws IOException

Returns the number of lines including the headers

Returns:

Throws:

IOException