org.fastnate.data.files

Class GenericDataProvider

java.lang.Object

org.fastnate.data.files.GenericDataProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

GenericXmlDataProvider

public abstract class GenericDataProvider
extends Object
implements DataProvider

Imports all entities from all files in $dataFolder/entities that match a specific pattern. The subclasses define the pattern (and type) of the imported files.

Author:

Tobias Liefke

Field Summary

Fields

Modifier and Type	Field and Description
private GeneratorContext	context The context of the current generator, with the description of the entity classes and settings.
private DataFolder	dataFolder The data folder defined for the entity importer.
private List<Collection<?>>	entities The entities as returned from the importers, to prevent useless allocation of another list.
private static String	ENTITIES_FOLDER The folder in the dataFolder that contains the entity files.
private EntityRegistration	entityRegistration Contains all already discovered entities with their unique property.
private static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
GenericDataProvider()

Method Summary

Modifier and Type	Method and Description
void	buildEntities() Builds the entities that are accessed later using DataProvider.writeEntities(EntitySqlGenerator).
protected EntityClass<?>	findEntityClass(DataFile importFile) Tries to guess the class of the imported entities from the file or directory name.
protected GeneratorContext	getContext() The context of the current generator, with the description of the entity classes and settings.
protected EntityRegistration	getEntityRegistration() Contains all already discovered entities with their unique property.
protected abstract Collection<?>	importFile(DataFile importFile) Tries to import the given file.
protected abstract boolean	isImportFile(DataFile file) Indicates that the given file is imported.
private void	readImportFile(DataFile file)
void	writeEntities(EntitySqlGenerator sqlGenerator) Adds all entities to the SQL file using the given generator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fastnate.data.DataProvider

getOrder

Field Detail

log

@Generated(value="lombok")
private static final org.slf4j.Logger log

ENTITIES_FOLDER

private static final String ENTITIES_FOLDER

The folder in the dataFolder that contains the entity files.

See Also:

Constant Field Values

context

private GeneratorContext context

The context of the current generator, with the description of the entity classes and settings.

entityRegistration

private EntityRegistration entityRegistration

Contains all already discovered entities with their unique property.

dataFolder

private DataFolder dataFolder

The data folder defined for the entity importer. The generic files are part of the ENTITIES_FOLDER inside of this folder.

entities

private final List<Collection<?>> entities

The entities as returned from the importers, to prevent useless allocation of another list.

Constructor Detail

GenericDataProvider

public GenericDataProvider()

Method Detail

buildEntities

public void buildEntities()
                   throws IOException

Description copied from interface: DataProvider

Builds the entities that are accessed later using DataProvider.writeEntities(EntitySqlGenerator).

Specified by:

buildEntities in interface DataProvider

Throws:

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

findEntityClass

protected EntityClass<?> findEntityClass(DataFile importFile)

Tries to guess the class of the imported entities from the file or directory name. If the file name matches an entity name, that entity class is returned, otherwise the directory tree is walked up until the root is found or an entity name is found.

Parameters:

importFile - the file that is imported

Returns:

the class according to the file or directory name

importFile

protected abstract Collection<?> importFile(DataFile importFile)
                                     throws DataImportException,
                                            IOException

Tries to import the given file.

Parameters:

importFile - the file that contains the entities

Returns:

the imported entities or null if the file was not imported

Throws:

IOException - if the file was not accessible

DataImportException - if the file content was invalid

isImportFile

protected abstract boolean isImportFile(DataFile file)

Indicates that the given file is imported. Most implementations will check the suffix of the file.

Parameters:

file - the file to check

Returns:

true if that file needs to be imported by this data provider

readImportFile

private void readImportFile(DataFile file)

writeEntities

public void writeEntities(EntitySqlGenerator sqlGenerator)
                   throws IOException

Description copied from interface: DataProvider

Adds all entities to the SQL file using the given generator.

Specified by:

writeEntities in interface DataProvider

Parameters:

sqlGenerator - the SQL file generator

Throws:

IOException - if the generator throws one

getContext

@Generated(value="lombok")
protected GeneratorContext getContext()

The context of the current generator, with the description of the entity classes and settings.

getEntityRegistration

@Generated(value="lombok")
protected EntityRegistration getEntityRegistration()

Contains all already discovered entities with their unique property.