nz.co.gregs.dbvolution.generation

Class DBTableClassGenerator

java.lang.Object

nz.co.gregs.dbvolution.generation.DBTableClassGenerator

public class DBTableClassGenerator
extends Object

Automatically generates Java files to be used in your data model.

DBvolution data model classes (DBRow subclasses) are designed to be easy to create and modify. However with a complex existing database it can be easier to use this class to generate the data model and then add the details.

Support DBvolution at Patreon

Author:

Gregory Graham

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBTableClassGenerator.Options

Method Summary

Methods

Modifier and Type	Method and Description
static void	generateClasses(DBDatabase database, String packageName, String baseDirectory) Creates DBTableRow classes corresponding to all the tables and views accessible to the user specified in the database supplied.
static void	generateClasses(DBDatabase database, String packageName, String baseDirectory, DBTableClassGenerator.Options options) Creates DBTableRow classes corresponding to all the tables and views accessible to the user specified in the database supplied.
static void	generateClasses(DBDatabase database, String packageName, String baseDirectory, Long versionNumber) Creates DBTableRow classes corresponding to all the tables and views accessible to the user specified in the database supplied.
static List<DBTableClass>	generateClassesOfTables(DBDatabase database, String packageName, DBTableClassGenerator.Options options) Generate the required Java classes for all the Tables on the database.
static List<DBTableClass>	generateClassesOfViews(DBDatabase database, String packageName, DBTableClassGenerator.Options options) Generate the required Java classes for all the Views on the database.
static String	toClassCase(String s) returns a good guess at the java CLASS version of a DB field name.

Methods inherited from class java.lang.Object

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

Method Detail

generateClasses

public static void generateClasses(DBDatabase database,
                   String packageName,
                   String baseDirectory)
                            throws SQLException,
                                   FileNotFoundException,
                                   IOException

Creates DBTableRow classes corresponding to all the tables and views accessible to the user specified in the database supplied.

Classes are placed in the correct subdirectory of the base directory as defined by the package name supplied.

Convenience method which calls generateClasses(jdbcURL, username, password, packageName, 1L, baseDirectory,new PrimaryKeyRecognisor(),new ForeignKeyRecognisor()); 1 Database exceptions may be thrown

Parameters:

database - database

packageName - packageName

baseDirectory - baseDirectory

Throws:

SQLException - java.sql.SQLException

FileNotFoundException - java.io.FileNotFoundException

IOException - java.io.IOException

generateClasses

public static void generateClasses(DBDatabase database,
                   String packageName,
                   String baseDirectory,
                   Long versionNumber)
                            throws SQLException,
                                   FileNotFoundException,
                                   IOException

Creates DBTableRow classes corresponding to all the tables and views accessible to the user specified in the database supplied.

Classes are placed in the correct subdirectory of the base directory as defined by the package name supplied.

Convenience method which calls generateClasses(jdbcURL,username,password,packageName,baseDirectory,new PrimaryKeyRecognisor(),new ForeignKeyRecognisor());

Parameters:

database - database

versionNumber - - the value to use for serialVersionUID 1 Database exceptions may be thrown

packageName - packageName

baseDirectory - baseDirectory

Throws:

SQLException - java.sql.SQLException

FileNotFoundException - java.io.FileNotFoundException

IOException - java.io.IOException

generateClasses

public static void generateClasses(DBDatabase database,
                   String packageName,
                   String baseDirectory,
                   DBTableClassGenerator.Options options)
                            throws SQLException,
                                   FileNotFoundException,
                                   IOException

Creates DBTableRow classes corresponding to all the tables and views accessible to the user specified in the database supplied.

Classes are placed in the correct subdirectory of the base directory as defined by the package name supplied.

Primary keys and foreign keys are created based on the definitions within the database and the results from the PK and FK recognisors.

Database exceptions may be thrown

Parameters:

database - database

packageName - packageName

baseDirectory - baseDirectory

options -

Throws:

SQLException - java.sql.SQLException

FileNotFoundException - java.io.FileNotFoundException

IOException - java.io.IOException

generateClassesOfTables

public static List<DBTableClass> generateClassesOfTables(DBDatabase database,
                                         String packageName,
                                         DBTableClassGenerator.Options options)
                                                  throws SQLException

Generate the required Java classes for all the Tables on the database.

Connects to the database using the DBDatabase instance supplied and generates class for the tables it can find.

Classes will be in the package supplied, serialVersionUID will be set to the version number supplied and the supplied PrimaryKeyRecognisor and ForeignKeyRecognisor will be used.

Parameters:

database - database

packageName - packageName

options -

Support DBvolution at Patreon

Returns:

a List of DBTableClass instances representing the tables found on the database 1 Database exceptions may be thrown

Throws:

SQLException - java.sql.SQLException

generateClassesOfViews

public static List<DBTableClass> generateClassesOfViews(DBDatabase database,
                                        String packageName,
                                        DBTableClassGenerator.Options options)
                                                 throws SQLException

Generate the required Java classes for all the Views on the database.

Connects to the database using the DBDatabase instance supplied and generates class for the views it can find.

Classes will be in the package supplied, serialVersionUID will be set to the version number supplied and the supplied PrimaryKeyRecognisor and ForeignKeyRecognisor will be used.

Parameters:

database - database

packageName - packageName

options -

Support DBvolution at Patreon

Returns:

a List of DBTableClass instances representing the views found on the database 1 Database exceptions may be thrown

Throws:

SQLException - java.sql.SQLException

toClassCase

public static String toClassCase(String s)

returns a good guess at the java CLASS version of a DB field name. I.e. changes "_" into an uppercase letter.

Parameters:

s - s

Support DBvolution at Patreon

Returns:

camel case version of the String