org.openestate.io.core

Class CsvParser<Record extends CsvRecord>

java.lang.Object

org.openestate.io.core.CsvParser<Record>

Type Parameters:

Record - the class used for a record, that is parsed from a CSV file

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

IdxParser, Is24CsvParser

public abstract class CsvParser<Record extends CsvRecord>
extends Object
implements Closeable

A general CSV parser, that is bound to a CsvFormat and reads CSV data into CsvRecord objects.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CsvParser(org.apache.commons.csv.CSVParser parser) Create with specifications of a CSVParser.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the parser instance.
long	getCurrentLineNumber() Returns the line number, that is currently processed by the parser.
long	getRecordNumber() Returns the total number of available records.
boolean	hasNext() Checks, if another record is available for the parser.
boolean	isClosed() Checks, if the parser instance was closed.
protected abstract Record	newRecord(org.apache.commons.csv.CSVRecord record) Creates a new CsvRecord with parsed CSV data.
Record	next()

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvParser

protected CsvParser(org.apache.commons.csv.CSVParser parser)

Create with specifications of a CSVParser.

Parameters:

parser - the CSV parser from commons-csv

Method Detail

close

public void close()
           throws IOException

Closes the parser instance.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if closing failed

getCurrentLineNumber

public final long getCurrentLineNumber()

Returns the line number, that is currently processed by the parser.

Returns:

line number

getRecordNumber

public final long getRecordNumber()

Returns the total number of available records.

Returns:

number of records

hasNext

public final boolean hasNext()

Checks, if another record is available for the parser.

Returns:

true, if another record is available, otherwise false

isClosed

public final boolean isClosed()

Checks, if the parser instance was closed.

Returns:

true, if the parser was closed, otherwise false

newRecord

protected abstract Record newRecord(org.apache.commons.csv.CSVRecord record)

Creates a new CsvRecord with parsed CSV data.

Parameters:

record - parsed CSV data from commons-csv

Returns:

created record

next

public final Record next()