org.fastnate.data.csv

Class AbstractCsvDataProvider<E>

java.lang.Object

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

org.fastnate.data.csv.AbstractCsvDataProvider<E>

Type Parameters:

E - The type of the generated objects

All Implemented Interfaces:

DataProvider

public abstract class AbstractCsvDataProvider<E>
extends AbstractCsvReader<E>
implements DataProvider

Base class for converters that create SQL files from CSV files.

Author:

Tobias Liefke

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,CsvPropertyConverter<?>>	columnConverter
private Map<String,String>	columnProperties
private Collection<E>	entities
private Set<String>	ignoredColumns
private boolean	ignoreUnknownColumns Indicates to ignore any column that can't be mapped to a property.
private static Map<Class<?>,CsvPropertyConverter<?>>	PROPERTY_CONVERTER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCsvDataProvider(File importPath) Initializes the converter from a path.

Method Summary

Modifier and Type	Method and Description
void	addColumnMapping(String column, String property) Defines the mapping from a column name to a property name.
void	addConverter(String column, CsvPropertyConverter<?> converter) Registers the converter to use for a specific column.
void	addIgnoredColumn(String column) Ignores a column during import.
protected boolean	applyColumn(E entity, String column, String value) Converts a column value to a property value and sets that property for an entity.
private boolean	applyColumn(E entity, String column, String property, String value)
void	buildEntities() Starts the generation of the SQL file from the list of CSV files.
protected <T> T	convertColumn(String column, Class<T> targetType, String value) Tries to convert the given string to a value of the given type for the given column.
protected Collection<? extends E>	createEntities(Map<String,String> row) Builds one or more entities from the given row.
protected E	createEntity() Creates a new empty entity for the current converter.
protected E	createEntity(Map<String,String> row) Builds one entity from the given row.
private <T> CsvPropertyConverter<? super T>	findConverter(Class<T> targetType)
Collection<E>	getEntities()
protected Class<E>	getEntityClass() The class of the created entities.
int	getOrder() Defaults to 0.
boolean	isIgnoredColumn(String column) Indicates that the given column is ignored during import.
boolean	isIgnoreUnknownColumns() Indicates to ignore any column that can't be mapped to a property.
void	setIgnoreUnknownColumns(boolean ignoreUnknownColumns) Indicates to ignore any column that can't be mapped to a property.
protected void	useTableColumns() Maps the table columns of the singular properties to the CSV columns.
void	writeEntities(EntitySqlGenerator sqlGenerator) Writes all created entities.

Methods inherited from class org.fastnate.data.csv.AbstractCsvReader

getDefaultEncoding, openCsvListReader, readImportFiles

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_CONVERTER

private static final Map<Class<?>,CsvPropertyConverter<?>> PROPERTY_CONVERTER

entities

private final Collection<E> entities

columnConverter

private final Map<String,CsvPropertyConverter<?>> columnConverter

columnProperties

private final Map<String,String> columnProperties

ignoredColumns

private final Set<String> ignoredColumns

ignoreUnknownColumns

private boolean ignoreUnknownColumns

Indicates to ignore any column that can't be mapped to a property.

Constructor Detail

AbstractCsvDataProvider

protected AbstractCsvDataProvider(File importPath)

Initializes the converter from a path.

Parameters:

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

Method Detail

addColumnMapping

public void addColumnMapping(String column,
                             String property)

Defines the mapping from a column name to a property name. Only necessary, if column name is not equal to property name

Parameters:

column - the name of the column

property - the name of the property

addConverter

public void addConverter(String column,
                         CsvPropertyConverter<?> converter)

Registers the converter to use for a specific column. Only nessecary, if the default converters are not enough for a specific column.

Parameters:

column - the name of the column

converter - used to convert that column from CSV to a Java value

addIgnoredColumn

public void addIgnoredColumn(String column)

Ignores a column during import.

Parameters:

column - the name of the column that is ignored

applyColumn

protected boolean applyColumn(E entity,
                              String column,
                              String value)

Converts a column value to a property value and sets that property for an entity.

Parameters:

entity - the entity to modify

column - the name of the current column

value - the value of the property (converts the property, if nessecary)

Returns:

true if an appropriate property was found, false if a matching property was not found and #isIgnoreUnknownColumns() is true

Throws:

IllegalArgumentException - if a matching property was not found or the was not converted

applyColumn

private boolean applyColumn(E entity,
                            String column,
                            String property,
                            String value)
                     throws IllegalAccessException,
                            InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

buildEntities

public void buildEntities()
                   throws IOException

Starts the generation of the SQL file from the list of CSV files.

Specified by:

buildEntities in interface DataProvider

Throws:

IOException - if something happens during any possible import of the generated entities

convertColumn

protected <T> T convertColumn(String column,
                              Class<T> targetType,
                              String value)

Tries to convert the given string to a value of the given type for the given column.

Parameters:

column - the name of the column

targetType - the target type

value - the string representation of the value

Returns:

the value for the property

createEntities

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

Builds one or more entities from the given row.

Specified by:

createEntities in class AbstractCsvReader<E>

Parameters:

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

Returns:

the list of entities from that row

createEntity

protected E createEntity()

Creates a new empty entity for the current converter. Used by the default implementation of createEntities(Map).

Returns:

the new entity

createEntity

protected E createEntity(Map<String,String> row)

Builds one entity from the given row.

Parameters:

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

Returns:

the created and filled entity

findConverter

private <T> CsvPropertyConverter<? super T> findConverter(Class<T> targetType)

getEntityClass

protected Class<E> getEntityClass()

The class of the created entities.

Returns:

the entity class

getOrder

public int getOrder()

Defaults to 0.

Specified by:

getOrder in interface DataProvider

Returns:

the order criteria - defaults to 0

isIgnoredColumn

public boolean isIgnoredColumn(String column)

Indicates that the given column is ignored during import.

Parameters:

column - the name of the column

Returns:

true if the column is not imported

useTableColumns

protected void useTableColumns()

Maps the table columns of the singular properties to the CSV columns. Useful if the CSV file is a database export.

writeEntities

public void writeEntities(EntitySqlGenerator sqlGenerator)
                   throws IOException

Writes all created entities.

Specified by:

writeEntities in interface DataProvider

Parameters:

sqlGenerator - the SQL file generator

Throws:

IOException - if the generator throws one

getEntities

@Generated(value="lombok")
public Collection<E> getEntities()

isIgnoreUnknownColumns

@Generated(value="lombok")
public boolean isIgnoreUnknownColumns()

Indicates to ignore any column that can't be mapped to a property.

setIgnoreUnknownColumns

@Generated(value="lombok")
public void setIgnoreUnknownColumns(boolean ignoreUnknownColumns)

Indicates to ignore any column that can't be mapped to a property.