org.dbrain.data.csv

Class CsvCursor

java.lang.Object

org.dbrain.data.csv.CsvCursor

All Implemented Interfaces:

AutoCloseable, ForwardCursor, IndexedFields, NamedFields

public class CsvCursor
extends Object
implements ForwardCursor, AutoCloseable

Tabular reader class to read CSV datasources.

Author:

poitrae

Constructor Summary

Constructors

Constructor and Description
CsvCursor(Reader reader, int separator) Create a new cursor to read tabular data from a text stream.
CsvCursor(Reader reader, int separator, int stringQuote) Create a new cursor to read tabular data from a text stream.
CsvCursor(Reader reader, int separator, int stringQuote, String[] fieldNames) Create a new cursor to read tabular data from a text stream.

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying cursor.
boolean	eof() Retrieve the End of File status.
Object	get(int index) Read the field value.
Object	get(String name) Get the value of the field or null.
boolean	next() Read the next line of data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dbrain.data.IndexedFields

getAs, getBoolean, getBooleanAs, getByte, getByteAs, getDouble, getDoubleAs, getFloat, getFloatAs, getInt, getIntAs, getLong, getLongAs, getShort, getShortAs, getString, getStringAs

Methods inherited from interface org.dbrain.data.NamedFields

getAs, getBoolean, getBooleanAs, getByte, getByteAs, getDouble, getDoubleAs, getFloat, getFloatAs, getInt, getIntAs, getLong, getLongAs, getShort, getShortAs, getString, getStringAs

Constructor Detail

CsvCursor

public CsvCursor(Reader reader,
                 int separator,
                 int stringQuote,
                 String[] fieldNames)

Create a new cursor to read tabular data from a text stream.

Allow to specify the fields name.

Parameters:

reader -

separator -

stringQuote -

CsvCursor

public CsvCursor(Reader reader,
                 int separator,
                 int stringQuote)

Create a new cursor to read tabular data from a text stream.

Parameters:

reader -

separator -

stringQuote -

CsvCursor

public CsvCursor(Reader reader,
                 int separator)

Create a new cursor to read tabular data from a text stream. Use no quote for string fields.

Parameters:

reader -

separator -

Method Detail

eof

public boolean eof()

Retrieve the End of File status.

Specified by:

eof in interface ForwardCursor

Returns:

True if stream at End of File.

next

public boolean next()

Read the next line of data.

Specified by:

next in interface ForwardCursor

Returns:

true if the cursor is not at end of file.

get

public Object get(int index)

Read the field value.

Specified by:

get in interface IndexedFields

Parameters:

index - Index of the field to read.

Returns:

The field value, as string.

get

public Object get(String name)

Get the value of the field or null.

Specified by:

get in interface NamedFields

Parameters:

name - Field name

Returns:

The getValue or null if getValue out of bound for this row.

close

public void close()
           throws Exception

Close the underlying cursor.

Specified by:

close in interface AutoCloseable

Throws:

Exception