org.fastnate.data.csv

Class AbstractCsvReader<R>

java.lang.Object

org.fastnate.data.csv.AbstractCsvReader<R>

Type Parameters:

R - the row type

Direct Known Subclasses:

AbstractCsvDataProvider

public abstract class AbstractCsvReader<R>
extends Object

Base class for reading a csv file into an object. Useful for constructing arbitrary object types - not only entities.

Author:

Andreas Penski

Constructor Summary

Constructors

Constructor and Description
AbstractCsvReader(File importPath) Creates a new instance of AbstractCsvReader.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<? extends R>	createEntities(Map<String,String> row) Builds one or more entities from the given row.
protected Charset	getDefaultEncoding() Defines the default encoding for CSV files, if it can't be determined from the BOM.
protected org.supercsv.io.CsvListReader	openCsvListReader(File importFile) Opens a CSV file.
protected Collection<R>	readImportFiles() Reads the import files.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCsvReader

public AbstractCsvReader(File importPath)

Creates a new instance of AbstractCsvReader.

Parameters:

importPath - the path to a file or to a directory that contains *.csv files

Method Detail

createEntities

protected abstract Collection<? extends R> createEntities(Map<String,String> row)

Builds one or more entities from the given row.

Parameters:

row - contains the mapping from the header names to the current row data

Returns:

the list of entities from that row

getDefaultEncoding

protected Charset getDefaultEncoding()

Defines the default encoding for CSV files, if it can't be determined from the BOM.

Returns:

the default encoding

openCsvListReader

protected org.supercsv.io.CsvListReader openCsvListReader(File importFile)
                                                   throws IOException

Opens a CSV file. If the given file ends with "gz", then the file is decompressed before using a GZIPInputStream.

Parameters:

importFile - the csv file

Returns:

a list reader

Throws:

IOException - on io exception

readImportFiles

protected Collection<R> readImportFiles()
                                 throws IOException

Reads the import files.

Returns:

collection of constructed entities

Throws:

IOException - on error