Package org.gbif.utils.file.csv

Class CSVReader

java.lang.Object

org.gbif.utils.file.csv.CSVReader

All Implemented Interfaces:

AutoCloseable, Iterator<String[]>, ClosableIterator<String[]>, ClosableReportingIterator<String[]>

public class CSVReader
extends Object
implements ClosableReportingIterator<String[]>

Field Summary

Fields

Modifier and Type	Field	Description
final String	delimiter
final String	encoding
final String[]	header
final int	headerRows
final Character	quoteChar

Constructor Summary

Constructors

Constructor	Description
CSVReader(File source, String encoding, String delimiter, Character quotes, Integer headerRows)
CSVReader(InputStream stream, String encoding, String delimiter, Character quotes, Integer headerRows)
CSVReader(InputStream stream, String encoding, String delimiter, Character quotes, Integer headerRows, int emptyLineCache)

Method Summary

Modifier and Type	Method	Description
void	close()
int	currLineNumber()
Set<Integer>	getEmptyLines()
String	getErrorMessage()	Return an informative message about the error encountered while iterating over row.
Exception	getException()	Return the Exception encountered while iterating over row.
String[]	getHeader()	Get the header, or null if none
int	getReadRows()
boolean	hasNext()
boolean	hasRowError()	Return true if an error was encountered while iterating over row.
String[]	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Details

headerRows

public final int headerRows

encoding

public final String encoding

delimiter

public final String delimiter

quoteChar

public final Character quoteChar

header

public final String[] header

Constructor Details

CSVReader

public CSVReader(File source,
 String encoding,
 String delimiter,
 Character quotes,
 Integer headerRows)
          throws IOException

Throws:

IOException

CSVReader

public CSVReader(InputStream stream,
 String encoding,
 String delimiter,
 Character quotes,
 Integer headerRows)
          throws IOException

Throws:

IOException

CSVReader

public CSVReader(InputStream stream,
 String encoding,
 String delimiter,
 Character quotes,
 Integer headerRows,
 int emptyLineCache)
          throws IOException

Throws:

IOException

Method Details

getHeader

public String[] getHeader()

Get the header, or null if none

close

public void close()

Specified by:

close in interface AutoCloseable

currLineNumber

public int currLineNumber()

Returns:

the current line number of the String[] iterator

getEmptyLines

public Set<Integer> getEmptyLines()

Returns:

a set of the line numbers of the firsts empty rows found in the file

getReadRows

public int getReadRows()

Returns:

the number of rows of data that were correctly read from the file

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<String[]>

next

public String[] next()

Specified by:

next in interface Iterator<String[]>

remove

public void remove()

Specified by:

remove in interface Iterator<String[]>

hasRowError

public boolean hasRowError()

Description copied from interface: ClosableReportingIterator

Return true if an error was encountered while iterating over row.

Specified by:

hasRowError in interface ClosableReportingIterator<String[]>

getErrorMessage

public String getErrorMessage()

Description copied from interface: ClosableReportingIterator

Return an informative message about the error encountered while iterating over row. Different from the Exception's message, used to store the row number, row string, etc.

Specified by:

getErrorMessage in interface ClosableReportingIterator<String[]>

getException

public Exception getException()

Description copied from interface: ClosableReportingIterator

Return the Exception encountered while iterating over row.

Specified by:

getException in interface ClosableReportingIterator<String[]>