com.asakusafw.runtime.io.text.csv

Class CsvFieldReader

java.lang.Object

com.asakusafw.runtime.io.text.csv.CsvFieldReader

All Implemented Interfaces:

FieldReader, Closeable, AutoCloseable

public class CsvFieldReader
extends Object
implements FieldReader

A FieldReader for RFC4180 style CSV files.

Since:

0.9.1

Constructor Summary

Constructors

Constructor and Description
CsvFieldReader(Reader reader, char fieldSeparator, char quoteCharacter, boolean allowLineFeed, UnaryOperator<CharSequence> transformer) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
CharSequence	getContent() Returns the content of the current field.
long	getFieldIndex() Returns the field index of the current field.
long	getRecordIndex() Returns the record index of the current field.
long	getRecordLineNumber() Returns the number of line where the current RECORD starts.
boolean	nextField() Advances the cursor and returns whether or not the next field exists in the current record.
boolean	nextRecord() Advances the cursor and returns whether or not the next record exists.
void	rewindFields() Rewinds the cursor to the head of the current record.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvFieldReader

public CsvFieldReader(Reader reader,
                      char fieldSeparator,
                      char quoteCharacter,
                      boolean allowLineFeed,
                      UnaryOperator<CharSequence> transformer)

Creates a new instance.

Parameters:

reader - the source text reader

fieldSeparator - the field separator character

quoteCharacter - the quote character

allowLineFeed - true to allow LF in field, otherwise false

transformer - the line content transformer (nullable)

Method Detail

nextRecord

public boolean nextRecord()
                   throws IOException

Description copied from interface: FieldReader

Advances the cursor and returns whether or not the next record exists. If the current record contains any unread fields, they will be ignored. This method may change the previous FieldReader.getContent() result object.

Specified by:

nextRecord in interface FieldReader

Returns:

true if the next record exists, otherwise false

Throws:

IOException - if I/O error occurred while reading the next record

nextField

public boolean nextField()
                  throws IOException

Description copied from interface: FieldReader

Advances the cursor and returns whether or not the next field exists in the current record. This method may change the previous FieldReader.getContent() result object.

Specified by:

nextField in interface FieldReader

Returns:

true if the next field exists, otherwise false

Throws:

IOException - if I/O error occurred while reading the next field

rewindFields

public void rewindFields()
                  throws IOException

Description copied from interface: FieldReader

Rewinds the cursor to the head of the current record.

Specified by:

rewindFields in interface FieldReader

Throws:

IOException - if I/O error occurred while rewinding fields

getContent

public CharSequence getContent()

Description copied from interface: FieldReader

Returns the content of the current field. Note that the content may be raw, it can contain quoting or escape sequences.

Specified by:

getContent in interface FieldReader

Returns:

the content, or null if this represents NULL

getRecordLineNumber

public long getRecordLineNumber()

Description copied from interface: FieldReader

Returns the number of line where the current RECORD starts.

Specified by:

getRecordLineNumber in interface FieldReader

Returns:

the line number (0-origin), or -1 if it is not sure

getRecordIndex

public long getRecordIndex()

Description copied from interface: FieldReader

Returns the record index of the current field.

Specified by:

getRecordIndex in interface FieldReader

Returns:

the record index (0-origin), or -1 if it is not sure

getFieldIndex

public long getFieldIndex()

Description copied from interface: FieldReader

Returns the field index of the current field.

Specified by:

getFieldIndex in interface FieldReader

Returns:

the field index (0-origin), or -1 if it is not sure

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException