EntityImporter (Fastnate Data Importer 1.6.0-SNAPSHOT API)

java.lang.Object
- org.fastnate.data.EntityImporter

```
public 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
`private GeneratorContext`	`context`
`static String`	`DATA_FOLDER_KEY` Settings key for the folder that contains any data to import.
`private DataFolder`	`dataFolder`
`private List<DataProvider>`	`dataProviders`
`static String`	`ENTITY_PACKAGES_KEY` Settings key for the packages to scan for entity classes on startup (separated by ';', ',', ':' or whitespaces).
`static String`	`FACTORY_KEY` Settings key for the fully qualified name of a class that scans and instantiates the `DataProvider`.
`static String`	`GENERATION_ABORTED_MESSAGE` The String in the SQL, if the generation was aborted.
`private static org.slf4j.Logger`	`log`
`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 (separated by ';', ',', ':' or whitespaces).
`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.
`static String`	`STATEMENTS_WRITER_KEY` Settings key that indicates the type of the used `StatementsWriter`.

Constructor Summary

Constructors
Constructor and Description
`EntityImporter()` Creates a new default instance of an EntityImporter.
`EntityImporter(GeneratorContext context)` Creates a new instance of an EntityImporter.
`EntityImporter(Properties settings)` Creates a new instance of an EntityImporter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDataProvider(DataProvider provider)` Adds a provider to the list of available providers.
`void`	`addDataProvider(DataProvider provider, int maximumOrderOfDepenendencies)` Adds a provider to the list of available providers.
`private static DataFolder`	`findDataFolder(GeneratorContext context)`
`<P extends DataProvider> P`	`findDataProvider(Class<P> providerClass)` Resolves the first provider that is an instance of the given class.
`GeneratorContext`	`getContext()`
`DataFolder`	`getDataFolder()`
`List<DataProvider>`	`getDataProviders()`
`private Charset`	`getEncoding()`
`Properties`	`getSettings()` The `settings` of the `context`.
`void`	`importData()` Imports the data and creates the SQL.
`void`	`importData(Connection connection)` Asks the data providers to generate their entities and writes the SQL to a database connection at the end.
`void`	`importData(EntitySqlGenerator generator)` Asks the data providers to generate their entities and writes the SQL afterwards.
`private void`	`importData(EntitySqlGenerator generator, Connection connection)`
`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 to a file at the end.
`static void`	`main(String[] args)` Starts the entity importer from the command line.
`private void`	`writePropertyPart(EntitySqlGenerator generator, String property)` Writes a section from a property to the writer of the SQL generator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
@Generated(value="lombok")
private static final org.slf4j.Logger log
```
  - 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. May point to a package name, which indicates that the folder is part of the class path. This setting may be overriden by the optional first command line argument of the importer. For importing entities with generic data providers, there has to be an "entities" folder in that folder, which contains the generic data files.
    
    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
  - FACTORY_KEY
```
public static final String FACTORY_KEY
```
    Settings key for the fully qualified name of a class that scans and instantiates the DataProvider. Defaults to DefaultDataProviderFactory.
    
    See Also:
    
    Constant Field Values
  - PACKAGES_KEY
```
public static final String PACKAGES_KEY
```
    Settings key for the packages to scan (separated by ';', ',', ':' or whitespaces).
    
    See Also:
    
    Constant Field Values
  - ENTITY_PACKAGES_KEY
```
public static final String ENTITY_PACKAGES_KEY
```
    Settings key for the packages to scan for entity classes on startup (separated by ';', ',', ':' or whitespaces).
    
    See Also:
    
    Constant Field Values
  - STATEMENTS_WRITER_KEY
```
public static final String STATEMENTS_WRITER_KEY
```
    Settings key that indicates the type of the used StatementsWriter. Allowed values of the setting:
    - FileStatementsWriter (default)
    - PostgreSqlBulkWriter
    - ConnectedStatementsWriter
    - LiquibaseStatementsWriter
    - any fully qualified class which has a constructor that accepts a GeneratorContext
    See Also:
    
    Constant Field Values
  - dataFolder
```
private final DataFolder dataFolder
```
  - context
```
private final GeneratorContext context
```
  - dataProviders
```
private final List<DataProvider> dataProviders
```
- Constructor Detail
  - EntityImporter
```
public EntityImporter()
```
    Creates a new default instance of an EntityImporter.
  - EntityImporter
```
public EntityImporter(GeneratorContext context)
```
    Creates a new instance of an EntityImporter.
    
    Parameters:
    
    context - the current generator context
  - EntityImporter
```
public EntityImporter(Properties settings)
```
    Creates a new instance of an EntityImporter.
    
    Parameters:
    
    settings - the settings of this importer, the data providers and the SQL generator
- Method Detail
  - findDataFolder
```
private static DataFolder findDataFolder(GeneratorContext context)
```
  - 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 / package of the base folder for reading input files (only used by DataProviders) - defaults to the setting of DATA_FOLDER_KEY.
    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
  - addDataProvider
```
public void addDataProvider(DataProvider provider)
```
    Adds a provider to the list of available providers. The provider will be added after the last provider with the same or a smaller order criteria.
    
    Parameters:
    
    provider - the provider
  - addDataProvider
```
public void addDataProvider(DataProvider provider,
                            int maximumOrderOfDepenendencies)
```
    Adds a provider to the list of available providers. The provider will be added after the last provider with the same or a smaller order criteria.
    
    Parameters:
    
    provider - the provider
    
    maximumOrderOfDepenendencies - the maximum ordering of dependencies of the provider
  - findDataProvider
```
public <P extends DataProvider> P findDataProvider(Class<P> providerClass)
```
    Resolves the first provider that is an instance of the given class.
    
    Parameters:
    
    providerClass - the provider class
    
    Returns:
    
    the provider with that class or null if no such provider exists
  - getEncoding
```
private Charset getEncoding()
```
  - getSettings
```
public Properties getSettings()
```
    The settings of the context.
    
    Returns:
    
    settings used by this importer
  - importData
```
public void importData()
                throws IOException
```
    Imports the data and creates the SQL. Depending on the setting STATEMENTS_WRITER_KEY, this will either create a file or execute the SQL against a connection.
    
    Throws:
    
    IOException - if one of the data importers or the file writer throws one
  - importData
```
public void importData(Connection connection)
                throws IOException,
                       SQLException
```
    Asks the data providers to generate their entities and writes the SQL to a database connection at the end.
    
    Parameters:
    
    connection - the target connection for the SQL statements
    
    Throws:
    
    SQLException - if the connection throws an exception
    
    IOException - if the generator throws an exception
  - importData
```
public void importData(EntitySqlGenerator generator)
                throws IOException
```
    Asks the data providers to generate their entities and writes the SQL afterwards.
    
    Parameters:
    
    generator - the current entity SQL generator
    
    Throws:
    
    IOException - if the generator throws an exception
  - importData
```
private void importData(EntitySqlGenerator generator,
                        Connection connection)
                 throws SQLException,
                        IOException
```
    Throws:
    
    SQLException
    
    IOException
  - 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 to a file at the end.
    
    Parameters:
    
    writer - the target writer for the SQL statements
    
    Throws:
    
    IOException - if the generator or writer throws an exception
  - writePropertyPart
```
private void writePropertyPart(EntitySqlGenerator generator,
                               String property)
                        throws IOException
```
    Writes a section from a property to the writer of the SQL generator.
    
    Parameters:
    
    generator - the current generator
    
    property - name of the property to write, contains either a list of file names (separated by ',' and ending with ".sql"), or an SQL statement
    
    Throws:
    
    IOException - if the writer or reader throws one
  - getDataFolder
```
@Generated(value="lombok")
public DataFolder getDataFolder()
```
  - getContext
```
@Generated(value="lombok")
public GeneratorContext getContext()
```
  - getDataProviders
```
@Generated(value="lombok")
public List<DataProvider> getDataProviders()
```

Class EntityImporter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

GENERATION_ABORTED_MESSAGE

DATA_FOLDER_KEY

OUTPUT_FILE_KEY

OUTPUT_ENCODING_KEY

PREFIX_KEY

POSTFIX_KEY

FACTORY_KEY

PACKAGES_KEY

ENTITY_PACKAGES_KEY

STATEMENTS_WRITER_KEY

dataFolder

context

dataProviders

Constructor Detail

EntityImporter

EntityImporter

EntityImporter

Method Detail

findDataFolder

main

addDataProvider

addDataProvider

findDataProvider

getEncoding

getSettings

importData

importData

importData

importData

importData

importData

writePropertyPart

getDataFolder

getContext

getDataProviders