Package org.refcodes.tabular

Class CsvInputStreamRecordsImpl<T>

java.lang.Object

org.refcodes.tabular.CsvInputStreamRecordsImpl<T>

Type Parameters:

T - The type managed by the Records.

All Implemented Interfaces:

Iterator<T>, HeaderAccessor<T>, InputStreamRecords<T>, Records<T>

Direct Known Subclasses:

CsvFileRecordsImpl

public class CsvInputStreamRecordsImpl<T>
extends Object
implements InputStreamRecords<T>

The CsvInputStreamRecordsImpl is an implementation of the Records interface and provides functionality to parse CSV input streams.

TODO: This class is still to be unit tested.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.tabular.HeaderAccessor

HeaderAccessor.HeaderBuilder<T extends HeaderAccessor.HeaderBuilder<?>>, HeaderAccessor.HeaderMutator<T>, HeaderAccessor.HeaderProperty<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
	CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory, InputStream aCsvInputStream)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory, InputStream aCsvInputStream, boolean isStrict)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory, InputStream aCsvInputStream, char aCsvDelimiter)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory, InputStream aCsvInputStream, char aCsvDelimiter, boolean isStrict)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(Header<T> aHeader, InputStream aCsvInputStream)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(Header<T> aHeader, InputStream aCsvInputStream, boolean isStrict)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(Header<T> aHeader, InputStream aCsvInputStream, char aCsvDelimiter)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
	CsvInputStreamRecordsImpl(Header<T> aHeader, InputStream aCsvInputStream, char aCsvDelimiter, boolean isStrict)	Constructs a CsvInputStreamRecordsImpl with the given parameters.
protected	CsvInputStreamRecordsImpl(Header<T> aHeader, ColumnFactory<T> aColumnFactory, InputStream aCsvInputStream, char aCsvDelimiter, boolean isStrict)	Constructs a CsvInputStreamRecordsImpl with the given parameters.

Method Summary

Modifier and Type	Method	Description
long	getErroneousRecordCount()	Gets the erroneous record count.
Header<T>	getHeader()	Retrieves the Header property.
boolean	hasNext()
Record<T>	next()	Next.
void	remove()

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(Header<T> aHeader,
                                 InputStream aCsvInputStream)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. Internally Column instances are generated according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values. If a Header is provided, then the Header is used for generating the Column instances instead of the top line of the CSV file.

Parameters:

aHeader - The Header to use when parsing the lines retrieved from the InputStream.

aCsvInputStream - The CSV InputStream which to parse.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(Header<T> aHeader,
                                 InputStream aCsvInputStream,
                                 boolean isStrict)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. Internally Column instances are generated according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values. If a Header is provided, then the Header is used for generating the Column instances instead of the top line of the CSV file.

Parameters:

aHeader - The Header to use when parsing the lines retrieved from the InputStream.

aCsvInputStream - The CSV InputStream which to parse.

isStrict - When true, then parsing will abort with an exception in case of parsing problems, else parsing is gracefully continued and erroneous records are skipped. The error count getErroneousRecordCount() is incremented by each erroneous Record.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(Header<T> aHeader,
                                 InputStream aCsvInputStream,
                                 char aCsvDelimiter)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. Internally Column instances are generated according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values. If a Header is provided, then the Header is used for generating the Column instances instead of the top line of the CSV file.

Parameters:

aHeader - The Header to use when parsing the lines retrieved from the InputStream.

aCsvInputStream - The CSV InputStream which to parse.

aCsvDelimiter - The delimiter being expected for the CSV input stream.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(Header<T> aHeader,
                                 InputStream aCsvInputStream,
                                 char aCsvDelimiter,
                                 boolean isStrict)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. Internally Column instances are generated according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values. If a Header is provided, then the Header is used for generating the Column instances instead of the top line of the CSV file.

Parameters:

aHeader - The Header to use when parsing the lines retrieved from the InputStream.

aCsvInputStream - The CSV InputStream which to parse.

aCsvDelimiter - The delimiter being expected for the CSV input stream.

isStrict - When true, then parsing will abort with an exception in case of parsing problems, else parsing is gracefully continued and erroneous records are skipped. The error count getErroneousRecordCount() is incremented by each erroneous Record.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory,
                                 InputStream aCsvInputStream)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. This constructor supports a ColumnFactory for creating Column instance according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values from the storage format to the actual required type.

Parameters:

aColumnFactory - A ColumnFactory to be used to generate Column instances from the top line of the CSF file, required for parsing the CSV lines and converting them to Record instances.

aCsvInputStream - The CSV InputStream which to parse.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory,
                                 InputStream aCsvInputStream,
                                 boolean isStrict)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. This constructor supports a ColumnFactory for creating Column instance according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values from the storage format to the actual required type.

Parameters:

aColumnFactory - A ColumnFactory to be used to generate Column instances from the top line of the CSF file, required for parsing the CSV lines and converting them to Record instances.

aCsvInputStream - The CSV InputStream which to parse.

isStrict - When true, then parsing will abort with an exception in case of parsing problems, else parsing is gracefully continued and erroneous records are skipped. The error count getErroneousRecordCount() is incremented by each erroneous Record.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory,
                                 InputStream aCsvInputStream,
                                 char aCsvDelimiter)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. This constructor supports a ColumnFactory for creating Column instance according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values from the storage format to the actual required type.

Parameters:

aColumnFactory - A ColumnFactory to be used to generate Column instances from the top line of the CSF file, required for parsing the CSV lines and converting them to Record instances.

aCsvInputStream - The CSV InputStream which to parse.

aCsvDelimiter - The delimiter being expected for the CSV input stream.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

public CsvInputStreamRecordsImpl(ColumnFactory<T> aColumnFactory,
                                 InputStream aCsvInputStream,
                                 char aCsvDelimiter,
                                 boolean isStrict)
                          throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. This constructor supports a ColumnFactory for creating Column instance according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values from the storage format to the actual required type.

Parameters:

aColumnFactory - A ColumnFactory to be used to generate Column instances from the top line of the CSF file, required for parsing the CSV lines and converting them to Record instances.

aCsvInputStream - The CSV InputStream which to parse.

aCsvDelimiter - The delimiter being expected for the CSV input stream.

isStrict - When true, then parsing will abort with an exception in case of parsing problems, else parsing is gracefully continued and erroneous records are skipped. The error count getErroneousRecordCount() is incremented by each erroneous Record.

Throws:

IOException - in case there were problems working with the given InputStream.

CsvInputStreamRecordsImpl

protected CsvInputStreamRecordsImpl(Header<T> aHeader,
                                    ColumnFactory<T> aColumnFactory,
                                    InputStream aCsvInputStream,
                                    char aCsvDelimiter,
                                    boolean isStrict)
                             throws IOException

Constructs a CsvInputStreamRecordsImpl with the given parameters. This constructor supports a ColumnFactory for creating Column instance according to the keys found in the CSV top line. The Column instances are required to convert the CSV line values from the storage format to the actual required type. If a Header is provided, then the Header is used for generating the Column instances instead of the top line of the CSV file.

Parameters:

aHeader - The Header to use when parsing the lines retrieved from the InputStream.

aColumnFactory - A ColumnFactory to be used to generate Column instances from the top line of the CSF file, required for parsing the CSV lines and converting them to Record instances.

aCsvInputStream - The CSV InputStream which to parse.

aCsvDelimiter - The delimiter being expected for the CSV input stream.

isStrict - When true, then parsing will abort with an exception in case of parsing problems, else parsing is gracefully continued and erroneous records are skipped. The error count getErroneousRecordCount() is incremented by each erroneous Record.

Throws:

IOException - in case there were problems working with the given InputStream.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public Record<T> next()

Next.

Specified by:

next in interface Iterator<T>

Returns:

the record

remove

public void remove()

Specified by:

remove in interface Iterator<T>

getHeader

public Header<T> getHeader()

Retrieves the Header property.

Specified by:

getHeader in interface HeaderAccessor<T>

Returns:

The Header being stored by this property.

getErroneousRecordCount

public long getErroneousRecordCount()

Gets the erroneous record count.

Specified by:

getErroneousRecordCount in interface InputStreamRecords<T>

Returns:

the erroneous record count