io.improbable.keanu.util.csv

Class CsvReader

java.lang.Object

io.improbable.keanu.util.csv.CsvReader

public class CsvReader
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CsvReader(java.util.function.Supplier<java.io.Reader> sourceSupplier)

Method Summary

Modifier and Type	Method and Description
<T> RowsAsObjectParser<T>	asRowsDefinedBy(java.lang.Class<T> clazz)
<T> ColumnsVectorizedObjectParser<T>	asVectorizedColumnsDefinedBy(java.lang.Class<T> clazz)
CsvReader	expectHeader(boolean expectHeader) Tells the reader to either treat the first line of the file as a header or as data.
java.util.List<java.lang.String>	getHeader() Gets the header of the csv file if one exist otherwise an empty list.
java.util.List<java.util.List<java.lang.String>>	readLines() This will read the entire csv file and return it as a list.
java.util.stream.Stream<java.util.List<java.lang.String>>	streamLines() Read all lines from the csv file one at a time without ever holding the entire csv file in memory
CsvReader	withDelimiter(java.lang.String delimiter) Defaults to a comma "," but could be \t for tab separated files or something else.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReader

public CsvReader(java.util.function.Supplier<java.io.Reader> sourceSupplier)

Method Detail

readLines

public java.util.List<java.util.List<java.lang.String>> readLines()

This will read the entire csv file and return it as a list. Warning: avoid using this for large csv files.

Returns:

a list lines that are represented as a list of strings where each string is a field in that line.

streamLines

public java.util.stream.Stream<java.util.List<java.lang.String>> streamLines()

Read all lines from the csv file one at a time without ever holding the entire csv file in memory

Returns:

a stream of lines represented by a list of strings where each string is a field in the line.

asRowsDefinedBy

public <T> RowsAsObjectParser<T> asRowsDefinedBy(java.lang.Class<T> clazz)

asVectorizedColumnsDefinedBy

public <T> ColumnsVectorizedObjectParser<T> asVectorizedColumnsDefinedBy(java.lang.Class<T> clazz)

getHeader

public java.util.List<java.lang.String> getHeader()

Gets the header of the csv file if one exist otherwise an empty list.

Returns:

the header

expectHeader

public CsvReader expectHeader(boolean expectHeader)

Tells the reader to either treat the first line of the file as a header or as data.

Parameters:

expectHeader - true for first line is header, false for data

Returns:

this reader

withDelimiter

public CsvReader withDelimiter(java.lang.String delimiter)

Defaults to a comma "," but could be \t for tab separated files or something else.

Parameters:

delimiter - the delimiter to use

Returns:

this reader