Package com.gengoai.io

Class CSVReader

java.lang.Object

com.gengoai.io.CSVReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<List<String>>

public class CSVReader
extends Object
implements Closeable, AutoCloseable, Iterable<List<String>>

Reads files in delimiter separated value format using a CSV specification.

Author:

David B. Bracewell

Constructor Summary

Constructors

Constructor	Description
CSVReader(CSV builder, Reader reader)	Instantiates a new CSVReader.

Method Summary

Modifier and Type	Method	Description
void	close()
void	forEach(Consumer<? super List<String>> consumer)	Convenience method for consuming all rows in the CSV file
List<String>	getHeader()	Gets the header read in from the csv file or specified via the CSV specification.
Iterator<List<String>>	iterator()
List<String>	nextRow()	Reads the next row from the CSV file retuning null if there are not anymore
<R> List<R>	processRows(SerializableFunction<List<String>,Optional<R>> converter)
List<List<String>>	readAll()	Runs the iterator over the entire resource returning all the rows it processed.
Stream<List<String>>	stream()	Creates a new stream over the rows in the file that will close underlying reader on stream close.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

spliterator

Constructor Detail

CSVReader

public CSVReader(CSV builder,
                 Reader reader)
          throws IOException

Instantiates a new CSVReader.

Parameters:

builder - the CSV specification

reader - the reader to read from

Throws:

IOException - Something went wrong initializing the CSVReader

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

forEach

public void forEach(Consumer<? super List<String>> consumer)

Convenience method for consuming all rows in the CSV file

Specified by:

forEach in interface Iterable<List<String>>

Parameters:

consumer - the consumer to use to process the rows

getHeader

public List<String> getHeader()

Gets the header read in from the csv file or specified via the CSV specification.

Returns:

The header of the CSV file

iterator

public Iterator<List<String>> iterator()

Specified by:

iterator in interface Iterable<List<String>>

nextRow

public List<String> nextRow()
                     throws IOException

Reads the next row from the CSV file retuning null if there are not anymore

Returns:

the row as a list of strings or null if there are not any more rows to read

Throws:

IOException - Something went wrong reading the file

processRows

public <R> List<R> processRows(SerializableFunction<List<String>,Optional<R>> converter)
                        throws IOException

Throws:

IOException

readAll

public List<List<String>> readAll()
                           throws IOException

Runs the iterator over the entire resource returning all the rows it processed.

Returns:

the list of rows (lists)

Throws:

IOException - the iO exception

stream

public Stream<List<String>> stream()

Creates a new stream over the rows in the file that will close underlying reader on stream close.

Returns:

the stream of rows in the file