com.asakusafw.runtime.io.csv

Class CsvParser

java.lang.Object

com.asakusafw.runtime.io.csv.CsvParser

All Implemented Interfaces:

RecordParser, Closeable, AutoCloseable

public class CsvParser
extends Object
implements RecordParser

A simple CSV parser.

Since:

0.2.4

Version:

0.7.3

Constructor Summary

Constructors

Constructor and Description
CsvParser(InputStream stream, String path, CsvConfiguration config) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
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.
long	getCurrentLineNumber() Returns the 1-origin line number where the current record is started.
long	getCurrentRecordNumber() Returns the 1-origin record number.
String	getPath() Returns the parsing target path.
boolean	next() Prepare for reading the next record.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvParser

public CsvParser(InputStream stream,
                 String path,
                 CsvConfiguration config)

Creates a new instance.

Parameters:

stream - the source stream

path - the source path

config - current configuration

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

next

public boolean next()
             throws CsvFormatException,
                    IOException

Description copied from interface: RecordParser

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

Specified by:

next in interface RecordParser

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

CsvFormatException

getPath

public String getPath()

Returns the parsing target path.

Returns:

the path

getCurrentLineNumber

public long getCurrentLineNumber()

Returns the 1-origin line number where the current record is started. Lines are delimited with CR, LF, and CRLF.

Returns:

the current line number

getCurrentRecordNumber

public long getCurrentRecordNumber()

Returns the 1-origin record number.

Returns:

the current record number.

fill

public void fill(BooleanOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(ByteOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(ShortOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(IntOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(LongOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(FloatOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(DoubleOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(DecimalOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(StringOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(DateOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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.

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

fill

public void fill(DateTimeOption option)
          throws CsvFormatException,
                 IOException

Description copied from interface: RecordParser

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.

Specified by:

fill in interface RecordParser

Parameters:

option - the target object

Throws:

RecordFormatException - if the record format is something wrong

IOException - if error occurred while reading the next cell

CsvFormatException

endRecord

public void endRecord()
               throws CsvFormatException,
                      IOException

Description copied from interface: RecordParser

Finalizes current record.

Specified by:

endRecord in interface RecordParser

Throws:

RecordFormatException - if current record is wrong

IOException - if failed to finalize this record

CsvFormatException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException