com.asakusafw.runtime.io.text

Interface FieldReader

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CsvFieldReader, TabularFieldReader

public interface FieldReader
extends Closeable

An abstract super interface which extracting records and their fields.

Since:

0.9.1

Method Summary

Modifier and Type	Method and Description
CharSequence	getContent() Returns the content of the current field.
default long	getFieldIndex() Returns the field index of the current field.
default long	getRecordIndex() Returns the record index of the current field.
default 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 interface java.io.Closeable

close

Method Detail

nextRecord

boolean nextRecord()
            throws IOException

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 getContent() result object.

Returns:

true if the next record exists, otherwise false

Throws:

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

TextFormatException - if text format is not valid

nextField

boolean nextField()
           throws IOException

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

Returns:

true if the next field exists, otherwise false

Throws:

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

TextFormatException - if text format is not valid

rewindFields

void rewindFields()
           throws IOException

Rewinds the cursor to the head of the current record.

Throws:

IOException - if I/O error occurred while rewinding fields

TextFormatException - if text format is not valid

getContent

CharSequence getContent()

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

Returns:

the content, or null if this represents NULL

Throws:

TextFormatException - if text format is not valid

getRecordLineNumber

default long getRecordLineNumber()

Returns the number of line where the current RECORD starts.

Returns:

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

getRecordIndex

default long getRecordIndex()

Returns the record index of the current field.

Returns:

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

getFieldIndex

default long getFieldIndex()

Returns the field index of the current field.

Returns:

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