com.asakusafw.runtime.io

Interface RecordParser

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CsvParser, TsvParser

public interface RecordParser
extends Closeable

Reads set of records and set each cell into ValueOption.

SomeModel model = new SomeModel();
try (RecordParser parser = ...) {
    while (parser.next()) {
        parser.fill(model.getHogeOption());
        parser.fill(model.getFooOption());
        parser.fill(model.getBarOption());
        parser.endRecord();
        performSomeAction(model);
    }
}

Each method in this interface may raise NullPointerException if parameters were null.

Since:

0.1.0

Version:

0.2.4

Method Summary

Modifier and Type	Method and Description
void	endRecord() Finalizes current record.
void	fill(BooleanOption option) Reads the next cell and set the value into the target object.
void	fill(ByteOption option) Reads the next cell and set the value into the target object.
void	fill(DateOption option) Reads the next cell and set the value into the target object.
void	fill(DateTimeOption option) Reads the next cell and set the value into the target object.
void	fill(DecimalOption option) Reads the next cell and set the value into the target object.
void	fill(DoubleOption option) Reads the next cell and set the value into the target object.
void	fill(FloatOption option) Reads the next cell and set the value into the target object.
void	fill(IntOption option) Reads the next cell and set the value into the target object.
void	fill(LongOption option) Reads the next cell and set the value into the target object.
void	fill(ShortOption option) Reads the next cell and set the value into the target object.
void	fill(StringOption option) Reads the next cell and set the value into the target object.
boolean	next() Prepare for reading the next record.

Methods inherited from interface java.io.Closeable

close

Method Detail

next

boolean next()
      throws RecordFormatException,
             IOException

Prepare for reading the next record. If the current record has any more remaining cells, this will raise an RecordFormatException.

Returns:

true if the next record exists, or otherwise false

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the head of the next record

fill

void fill(BooleanOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(ByteOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(ShortOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(IntOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(LongOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(FloatOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(DoubleOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(DecimalOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(StringOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(DateOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object. If either year, month, or day field was 0, this set null to the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

fill

void fill(DateTimeOption option)
   throws RecordFormatException,
          IOException

Reads the next cell and set the value into the target object. If either year, month, or day field was 0, this set null to the target object.

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

endRecord

void endRecord()
        throws RecordFormatException,
               IOException

Finalizes current record.

Throws:

RecordFormatException - if current record is wrong

IOException - if failed to finalize this record