nl.knowledgeplaza.util.jpa
Class JpaReverseEngineer

java.lang.Object
  nl.knowledgeplaza.util.jpa.JpaReverseEngineer

public class JpaReverseEngineer
extends Object

This class reverse engineers a business model (BM) from a RDBMS schema via a JDBC connection. The generated BM is not thread safe, this means only one thread-per-entity-manager is allowed to access the BM. If you have code (like swing applications) that spawn threads, make sure only one is accessing the BM at the same time using a lock or other synchronization mechanism. http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html Since it practically is impossible to write thread safe BM's (like it is to write threads safe GUI libraries, like Swing), this is left to the developer. Please be aware that when coding against another threading environment (e.g. Swing) this may result in some "interesting" logic, especially when using a binding library. For example: suppose a separate thread was spawned to do some heavy lifting in the BM. This thread will do some work, create or alter collections, and as a result some Swing components have to be updated. The Swing components most likely will directly use the BM, e.g. a List that will shown, say, Persons using a custom Renderer, or a Textfield that displays a name or total. These swing components most likely are bound to the BM using a binding library (e.g. JGoodies). Ok, suppose the worker sets the name of a person, the binding library will then automatically update the TextField. But unless the binding library hands it over to the Swing Thread, this will be done outside the Swing thread! To be continued...

Author:

tom

Field Summary

static String

ATLOADTIMEPOSTFIX

Constructor Summary

JpaReverseEngineer()

Method Summary

protected String	convertDbIdentifierToJavaNotation(String id, String type, boolean stripIdPostfix) Converts database id to java id, allowing for id overriding, and incorporates stripping
static String	convertDbIdentifierToJavaNotationPure(String id) Converts a database id to java id without any tuning The resulting Java camelcase ID will start with a capital
protected String	convertDbIdentifierToJavaProperty(String id, String type) Without stripping "nr"
protected String	convertDbIdentifierToJavaPropertyStripIdPostfix(String id, String type) With stripping "nr"
void	generateClass(File javaFile, String packageName, String tableName, String className, boolean isWritable)
void	generateClass(String baseDirName, String packageName, String tableName, boolean isWritable)
void	generatePKClass(File lJavaFile, String lPackageName, String lTableName, String lClassName, List<String> lPrimaryKeys, Map<String,String> primaryKeyColumnToJava)
protected String	getWhereIAm()
void	go()
static void	main(String[] args)
protected String	pullThroughConfigurationPropertiesRenameRules(String id, String type) See if there are rename rules for this id
protected boolean	skipTable(String tableName)
protected void	writeComparator(Map<String,String> properties, String packageName, String className, Writer lWriter)
protected String	writeDefaultValue(String lJavaType, String defaultValue)
protected void	writeFindBy(Map<String,String> properties, String packageName, String className, Writer lWriter, List<String> findByMethods) Generate additional findBy methods using unique properties

Methods inherited from class java.lang.Object

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

Field Detail

ATLOADTIMEPOSTFIX

public static String ATLOADTIMEPOSTFIX

Constructor Detail

JpaReverseEngineer

public JpaReverseEngineer()

Parameters:

properties -

Method Detail

main

public static void main(String[] args)

Parameters:

args -

go

public void go()
        throws SQLException

Throws:

SQLException

generateClass

public void generateClass(String baseDirName,
                          String packageName,
                          String tableName,
                          boolean isWritable)
                   throws SQLException

Parameters:

databaseMetaDataRs -

Throws:

SQLException

generateClass

public void generateClass(File javaFile,
                          String packageName,
                          String tableName,
                          String className,
                          boolean isWritable)
                   throws IOException,
                          SQLException

Parameters:

databaseMetaDataRs -

Throws:

IOException

SQLException

generatePKClass

public void generatePKClass(File lJavaFile,
                            String lPackageName,
                            String lTableName,
                            String lClassName,
                            List<String> lPrimaryKeys,
                            Map<String,String> primaryKeyColumnToJava)
                     throws IOException,
                            SQLException

Parameters:

databaseMetaDataRs -

Throws:

IOException

SQLException

writeFindBy

protected void writeFindBy(Map<String,String> properties,
                           String packageName,
                           String className,
                           Writer lWriter,
                           List<String> findByMethods)
                    throws IOException

Generate additional findBy methods using unique properties

Parameters:

properties -

Throws:

IOException

writeComparator

protected void writeComparator(Map<String,String> properties,
                               String packageName,
                               String className,
                               Writer lWriter)
                        throws IOException

Parameters:

properties -

packageName -

className -

lWriter -

Throws:

IOException

convertDbIdentifierToJavaPropertyStripIdPostfix

protected String convertDbIdentifierToJavaPropertyStripIdPostfix(String id,
                                                                 String type)

With stripping "nr"

Parameters:

lId -

Returns:

convertDbIdentifierToJavaProperty

protected String convertDbIdentifierToJavaProperty(String id,
                                                   String type)

Without stripping "nr"

Parameters:

lId -

Returns:

convertDbIdentifierToJavaNotation

protected String convertDbIdentifierToJavaNotation(String id,
                                                   String type,
                                                   boolean stripIdPostfix)

Converts database id to java id, allowing for id overriding, and incorporates stripping

Parameters:

lId -

Returns:

convertDbIdentifierToJavaNotationPure

public static String convertDbIdentifierToJavaNotationPure(String id)

Converts a database id to java id without any tuning The resulting Java camelcase ID will start with a capital

Parameters:

id -

Returns:

pullThroughConfigurationPropertiesRenameRules

protected String pullThroughConfigurationPropertiesRenameRules(String id,
                                                               String type)

See if there are rename rules for this id

Parameters:

lId -

Returns:

writeDefaultValue

protected String writeDefaultValue(String lJavaType,
                                   String defaultValue)

Parameters:

lColumnType -

Returns:

getWhereIAm

protected String getWhereIAm()

skipTable

protected boolean skipTable(String tableName)