Package org.tribuo.data.csv

Class CSVIterator

java.lang.Object

com.oracle.labs.mlrg.olcut.util.IOSpliterator<ColumnarIterator.Row>

org.tribuo.data.columnar.ColumnarIterator

org.tribuo.data.csv.CSVIterator

All Implemented Interfaces:

AutoCloseable, Iterator<ColumnarIterator.Row>, Spliterator<ColumnarIterator.Row>

public class CSVIterator
extends ColumnarIterator
implements AutoCloseable

An iterator over a CSV file.

Nested Class Summary

Nested classes/interfaces inherited from class org.tribuo.data.columnar.ColumnarIterator

ColumnarIterator.Row

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T extends Object,T_CONS extends Object,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields

Modifier and Type	Field	Description
static final char	QUOTE	Default quote character.
static final char	SEPARATOR	Default separator character.

Fields inherited from class org.tribuo.data.columnar.ColumnarIterator

currentRow, fields

Fields inherited from class com.oracle.labs.mlrg.olcut.util.IOSpliterator

DEFAULT_BATCH_SIZE, DEFAULT_CHARACTERISTICS

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor	Description
CSVIterator(Reader rdr)	Builds a CSVIterator for the supplied Reader.
CSVIterator(Reader rdr, char separator, char quote)	Builds a CSVIterator for the supplied Reader.
CSVIterator(Reader rdr, char separator, char quote, String[] fields)	Builds a CSVIterator for the supplied Reader.
CSVIterator(Reader rdr, char separator, char quote, List<String> fields)	Builds a CSVIterator for the supplied Reader.
CSVIterator(URI dataFile)	Builds a CSVIterator for the supplied URI.
CSVIterator(URI dataFile, char separator, char quote)	Builds a CSVIterator for the supplied URI.
CSVIterator(URI dataFile, char separator, char quote, String[] fields)	Builds a CSVIterator for the supplied URI.
CSVIterator(URI dataFile, char separator, char quote, List<String> fields)	Builds a CSVIterator for the supplied URI.

Method Summary

Modifier and Type	Method	Description
void	close()
protected Optional<ColumnarIterator.Row>	getRow()	Returns the next row of data based on internal state stored by the implementor, or Optional.empty() if there is no more data.

Methods inherited from class org.tribuo.data.columnar.ColumnarIterator

forEachRemaining, getFields, hasNext, next, tryAdvance

Methods inherited from class com.oracle.labs.mlrg.olcut.util.IOSpliterator

characteristics, estimateSize, trySplit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

remove

Methods inherited from interface java.util.Spliterator

getComparator, getExactSizeIfKnown, hasCharacteristics

Field Details

SEPARATOR

public static final char SEPARATOR

Default separator character.

See Also:

• Constant Field Values

QUOTE

public static final char QUOTE

Default quote character.

See Also:

• Constant Field Values

Constructor Details

CSVIterator

public CSVIterator(Reader rdr)

Builds a CSVIterator for the supplied Reader. Defaults to SEPARATOR for the separator and QUOTE for the quote.

Parameters:

rdr - The source to read.

CSVIterator

public CSVIterator(Reader rdr,
 char separator,
 char quote)

Builds a CSVIterator for the supplied Reader.

Parameters:

rdr - The source to read.

separator - The separator character to use.

quote - The quote character to use.

CSVIterator

public CSVIterator(URI dataFile)
            throws IOException

Builds a CSVIterator for the supplied URI. Defaults to SEPARATOR for the separator and QUOTE for the quote.

Parameters:

dataFile - The source to read.

Throws:

IOException - thrown if the file is not readable in some way.

CSVIterator

public CSVIterator(URI dataFile,
 char separator,
 char quote)
            throws IOException

Builds a CSVIterator for the supplied URI.

Parameters:

dataFile - The source to read.

separator - The separator character to use.

quote - The quote character to use.

Throws:

IOException - thrown if the file is not readable in some way.

CSVIterator

public CSVIterator(URI dataFile,
 char separator,
 char quote,
 String[] fields)
            throws IOException

Builds a CSVIterator for the supplied URI. If headers is null or an empty array, read the headers from the csv file.

Parameters:

dataFile - The source to read.

separator - The separator character to use.

quote - The quote character to use.

fields - The headers to use.

Throws:

IOException - thrown if the file is not readable in some way.

CSVIterator

public CSVIterator(URI dataFile,
 char separator,
 char quote,
 List<String> fields)
            throws IOException

Builds a CSVIterator for the supplied URI.

Parameters:

dataFile - The source to read.

separator - The separator character to use.

quote - The quote character to use.

fields - The headers to use.

Throws:

IOException - thrown if the file is not readable in some way.

CSVIterator

public CSVIterator(Reader rdr,
 char separator,
 char quote,
 String[] fields)

Builds a CSVIterator for the supplied Reader. If headers is null or an empty array, read the headers from the csv file.

Parameters:

rdr - The source to read.

separator - The separator character to use.

quote - The quote character to use.

fields - The headers to use.

CSVIterator

public CSVIterator(Reader rdr,
 char separator,
 char quote,
 List<String> fields)

Builds a CSVIterator for the supplied Reader. If headers is null or an empty list, read the headers from the csv file.

Parameters:

rdr - The source to read.

separator - The separator character to use.

quote - The quote character to use.

fields - The headers to use.

Method Details

getRow

protected Optional<ColumnarIterator.Row> getRow()

Description copied from class: ColumnarIterator

Returns the next row of data based on internal state stored by the implementor, or Optional.empty() if there is no more data.

Specified by:

getRow in class ColumnarIterator

Returns:

The next row of data or None.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException