org.fastnate.data

Class EntityImporter

java.lang.Object

org.fastnate.data.EntityImporter

public final class EntityImporter
extends Object

Main class for importing entities. Discovers all implementations of DataProvider and creates one big SQL file for the generated entities.

Author:

Andreas Penski, Tobias Liefke

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_FOLDER_KEY Settings key for the folder that contains any data to import.
static String	GENERATION_ABORTED_MESSAGE The String in the SQL, if the generation was aborted.
static String	OUTPUT_ENCODING_KEY Settings key for the encoding of the generated SQL file.
static String	OUTPUT_FILE_KEY Settings key for the generated SQL file.
static String	PACKAGES_KEY Settings key for the packages to scan.
static String	POSTFIX_KEY Settings key for a part to write into the output file after the generated content.
static String	PREFIX_KEY Settings key for a part to write into the output file before the generated content.

Constructor Summary

Constructors

Constructor and Description
EntityImporter() Creates a new default instance of an EntityImporter.
EntityImporter(Properties settings) Creates a new instance of an EntityImporter.
EntityImporter(Properties settings, File dataFolder, GeneratorContext context) Creates a new instance of an EntityImporter.

Method Summary

Modifier and Type	Method and Description
void	importData() Imports the data and creates the default SQL file.
void	importData(File targetFile) Imports the data and creates the given SQL file.
void	importData(Writer writer) Asks the data providers to generate their entities and writes the SQL afterwards.
static void	main(String[] args) Starts the entity importer from the command line.

Methods inherited from class java.lang.Object

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

Field Detail

GENERATION_ABORTED_MESSAGE

public static final String GENERATION_ABORTED_MESSAGE

The String in the SQL, if the generation was aborted. Can be used by other utilities that perform further modifications on the generated files.

See Also:

Constant Field Values

DATA_FOLDER_KEY

public static final String DATA_FOLDER_KEY

Settings key for the folder that contains any data to import.

See Also:

Constant Field Values

OUTPUT_FILE_KEY

public static final String OUTPUT_FILE_KEY

Settings key for the generated SQL file.

See Also:

Constant Field Values

OUTPUT_ENCODING_KEY

public static final String OUTPUT_ENCODING_KEY

Settings key for the encoding of the generated SQL file.

See Also:

Constant Field Values

PREFIX_KEY

public static final String PREFIX_KEY

Settings key for a part to write into the output file before the generated content.

See Also:

Constant Field Values

POSTFIX_KEY

public static final String POSTFIX_KEY

Settings key for a part to write into the output file after the generated content.

See Also:

Constant Field Values

PACKAGES_KEY

public static final String PACKAGES_KEY

Settings key for the packages to scan.

See Also:

Constant Field Values

Constructor Detail

EntityImporter

public EntityImporter()

Creates a new default instance of an EntityImporter.

EntityImporter

public EntityImporter(Properties settings)

Creates a new instance of an EntityImporter.

Parameters:

settings - the settings of this importer and

EntityImporter

public EntityImporter(Properties settings,
                      File dataFolder,
                      GeneratorContext context)

Creates a new instance of an EntityImporter.

Parameters:

settings - contains additional settings for this importer

dataFolder - the base folder for the data providers

context - the current generator context

Method Detail

main

public static void main(String[] args)
                 throws IOException

Starts the entity importer from the command line. Command line arguments:

1. (optional) the name or path of the generated file - defaults to "data.sql"
2. (optional) the path of the base folder for reading input files (only used by DataProviders) - defaults to the current folder

You can set any other properties for EntityImporter(Properties) or GeneratorContext with system properties

Parameters:

args - the command line arguments (see above)

Throws:

IOException - the exception

importData

public void importData()
                throws IOException

Imports the data and creates the default SQL file.

Throws:

IOException - if one of the data importers or the file writer throws one

importData

public void importData(File targetFile)
                throws IOException

Imports the data and creates the given SQL file.

Parameters:

targetFile - the SQL file to generate

Throws:

IOException - if one of the data importers or the file writer throws one

importData

public void importData(Writer writer)
                throws IOException

Asks the data providers to generate their entities and writes the SQL afterwards.

Parameters:

writer - the target writer for

Throws:

IOException - if the generator throws an exception