com.groiss.fileimport.csv

Class CSVReader

java.lang.Object

com.groiss.fileimport.csv.CSVReader

All Implemented Interfaces:

StructuredFileReader, AutoCloseable

public class CSVReader
extends Object
implements StructuredFileReader

a utility class which reads RFC4180 (CSV http://tools.ietf.org/html/rfc4180) compliant records from an inputstream many setter-methods for changing the behavior are available there's also a way for reading fixed length records

Constructor Summary

Constructors

Constructor and Description
CSVReader()
CSVReader(CSVSettings settings)
CSVReader(Element config)
CSVReader(InputStream input)
CSVReader(InputStream input, Charset charset)
CSVReader(InputStream input, CSVSettings settings)
CSVReader(Reader input)
CSVReader(Reader input, CSVSettings settings)

Method Summary

Modifier and Type	Method and Description
void	close() closes the underlying IO-structures and releases any resources.
Object	get(int index) returns the field with the given index of the current record
Object	get(String columnName) returns the field with the given name of the current record is only working if headers are set
String	getRowComment()
int	getRowCount() returns the current amount of successfully read rows
CSVSettings	getSettings() returns the settings applied to this reader
Map<String,Object>	getValueMap() gets the current record's values mapped to the column names if the column names aren't unique, the values may be overwritten
boolean	readRecord() reads the next record data will be available thru get(int) and get(String)
void	skipRecord() skips one record
void	skipRecords(int count) skips count records

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVReader

public CSVReader()

CSVReader

public CSVReader(CSVSettings settings)

Parameters:

settings - to use

CSVReader

public CSVReader(Element config)
          throws InstantiationException,
                 IllegalAccessException,
                 ClassNotFoundException

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

CSVReader

public CSVReader(InputStream input)

Parameters:

input - the stream to read from

CSVReader

public CSVReader(InputStream input,
                 Charset charset)

Parameters:

input - the stream to read from

charset - the charset to use

CSVReader

public CSVReader(InputStream input,
                 CSVSettings settings)

Parameters:

input - the stream to read from

settings - the settings to use

CSVReader

public CSVReader(Reader input)

Parameters:

input - the reader to read from

CSVReader

public CSVReader(Reader input,
                 CSVSettings settings)

Parameters:

input - the reader to read from

settings - the settings to use

Method Detail

get

public Object get(int index)

returns the field with the given index of the current record

Parameters:

index -

Returns:

get

public Object get(String columnName)

returns the field with the given name of the current record is only working if headers are set

Parameters:

columnName -

Returns:

getRowCount

public int getRowCount()

Description copied from interface: StructuredFileReader

returns the current amount of successfully read rows

Specified by:

getRowCount in interface StructuredFileReader

Returns:

the rowCount

getSettings

public CSVSettings getSettings()

Description copied from interface: StructuredFileReader

returns the settings applied to this reader

Specified by:

getSettings in interface StructuredFileReader

Returns:

getValueMap

public Map<String,Object> getValueMap()

Description copied from interface: StructuredFileReader

gets the current record's values mapped to the column names if the column names aren't unique, the values may be overwritten

Specified by:

getValueMap in interface StructuredFileReader

Returns:

readRecord

public boolean readRecord()
                   throws IOException

reads the next record data will be available thru get(int) and get(String)

Specified by:

readRecord in interface StructuredFileReader

Returns:

Throws:

IOException

skipRecord

public void skipRecord()
                throws IOException

skips one record

Throws:

IOException

skipRecords

public void skipRecords(int count)
                 throws IOException

skips count records

Parameters:

count -

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: StructuredFileReader

closes the underlying IO-structures and releases any resources. no further reading may be possible

Specified by:

close in interface StructuredFileReader

Specified by:

close in interface AutoCloseable

Throws:

IOException

getRowComment

public String getRowComment()