org.gbif.utils.file.tabular

Interface TabularDataFileReader<T>

All Superinterfaces:

AutoCloseable, Closeable

public interface TabularDataFileReader<T>
extends Closeable

Interface defining a reader for tabular data file (e.g. CSV)

Method Summary

Modifier and Type	Method and Description
List<String>	getHeaderLine() Get the header line of the tabular data file (if possible).
long	getLastRecordLineNumber() The line number of where the last record returned by read() starts.
long	getLastRecordNumber() Represents the number of record returned by the read() method.
T	read() Read a non-empty line of the tabular data file.

Methods inherited from interface java.io.Closeable

close

Method Detail

getHeaderLine

List<String> getHeaderLine()
                    throws IOException

Get the header line of the tabular data file (if possible).

Returns:

headers or null

Throws:

IOException

read

T read()
throws IOException,
       ParseException

Read a non-empty line of the tabular data file. An empty line represents a line with no printable characters. A line with only the defined separators is expected to be returned.

Returns:

the next line of the tabular data file or null if the end of the file is reached.

Throws:

IOException

ParseException

getLastRecordLineNumber

long getLastRecordLineNumber()

The line number of where the last record returned by read() starts. If no records have been returned yet this method is expected to return 0. Once read() returned null, this methods will return the number of the last line in the file. Note that if the very last line is an empty line with only an endline character it will not be counted. Line number includes header line and empty lines (if applicable).

Returns:

line number of where the last record starts

getLastRecordNumber

long getLastRecordNumber()

Represents the number of record returned by the read() method. If no records have been returned yet this method is expected to return 0. A record can span over multiple line.

Returns: