org.dbtools.gen.DBObjectsBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbtools-gen Show documentation
DBTools ORM Class Generator.
There is a newer version: 11.0.0
/*
 * GroupObjectBuilder.java
 *
 * Created on March 15, 2003
 *
 * Copyright 2006 Jeff Campbell. All rights reserved. Unauthorized reproduction 
 * is a violation of applicable law. This material contains certain 
 * confidential or proprietary information and trade secrets of Jeff Campbell.
 */
package org.dbtools.gen;


import org.dbtools.renderer.SchemaRenderer;
import org.dbtools.schema.schemafile.*;
import org.dbtools.util.JavaUtil;
import org.dbtools.util.PackageUtil;

import java.io.File;
import java.util.List;

/**
 * @author jeff
 */
public abstract class DBObjectsBuilder {

    private String xmlFilename;
    private String schemaDatabaseName;
    private List tables;
    private List views;
    private List queries;
    private String outputBaseDir;
    private String packageBase;
    // used internally
    private SchemaRenderer schemaRenderer;
    private GenConfig genConfig;

    public abstract DBObjectBuilder getObjectBuilder();

    private int numberFilesGenerated;

    /**
     * Creates a new instance of DBObjectsBuilder
     */
    public DBObjectsBuilder(GenConfig genConfig) {
        this.genConfig = genConfig;
        schemaRenderer = new SchemaRenderer();
    }

    public DBObjectsBuilder(String xmlFilename, String packageBase, String outputBaseDir) {
        setXmlFilename(xmlFilename);
        setPackageBase(packageBase);
        setOutputBaseDir(outputBaseDir);
    }

    private void resetData() {
        tables = null;
        views = null;
        queries = null;
        numberFilesGenerated = 0;
    }

    private boolean validate() {
        if (outputBaseDir == null || outputBaseDir.equals("")) {
            throw new IllegalStateException("No baseDir specified");
        }

        return true;
    }

    public boolean build() {
        if (schemaDatabaseName != null && !schemaDatabaseName.isEmpty()) {
            return build(schemaRenderer.getDbSchema().getDatabase(schemaDatabaseName));
        } else {
            return buildAllDatabases();
        }
    }

    private boolean buildAllDatabases() {
        DatabaseSchema databaseSchema = schemaRenderer.getDbSchema();
        for (SchemaDatabase database : databaseSchema.getDatabases()) {
            resetData(); // prepare for new database
            if (!build(database)) {
                return false;
            }
        }

        onPostBuild(databaseSchema, packageBase, outputBaseDir, genConfig);

        return true;
    }

    public void onPostBuild(DatabaseSchema databaseSchema, String packageBase, String outputBaseDir, GenConfig genConfig) {
    }

    private boolean build(SchemaDatabase database) {
        boolean success = true;

        System.out.println("DATABASE: " + database.getName(false));

        // if tables is null... assume all tables
        if (tables == null) {
            tables = schemaRenderer.getTablesToGenerate(database, null);
        }

        if (views == null) {
            views = schemaRenderer.getViewsToGenerate(database, null);
        }

        if (queries == null) {
            queries = schemaRenderer.getQueriesToGenerate(database, null);
        }

        if (validate()) {
            DBObjectBuilder objectBuilder = getObjectBuilder();

            if (objectBuilder == null) {
                throw new IllegalStateException("No Table Renderer specified");
            }

            for (SchemaTable table : tables) {
                // crete the directory
                String packageDir = table.getClassName().toLowerCase();

                if (genConfig.isIncludeDatabaseNameInPackage()) {
                    packageDir = database.getName(true).toLowerCase() + "/" + packageDir;
                }

                String outDir = createOutputDir(outputBaseDir, packageDir);

                // package
                String packageName = packageBase + (genConfig.isIncludeDatabaseNameInPackage() ? '.' + database.getName(true).toLowerCase() : "");
                packageName = JavaUtil.createTablePackageName(packageName, table.getClassName());

                success = objectBuilder.build(database, table, packageName, outDir, genConfig);
                numberFilesGenerated += objectBuilder.getNumberFilesGenerated();
            }

            for (SchemaView view : views) {
                // crete the directory
                String packageDir = view.getClassName().toLowerCase();

                if (genConfig.isIncludeDatabaseNameInPackage()) {
                    packageDir = database.getName(true).toLowerCase() + "/" + packageDir;
                }

                String outDir = createOutputDir(outputBaseDir, packageDir);

                // package
                String packageName = packageBase + (genConfig.isIncludeDatabaseNameInPackage() ? '.' + database.getName(true).toLowerCase() : "");
                packageName = packageName + "." + view.getClassName().toLowerCase();

                success = objectBuilder.build(database, view, packageName, outDir, genConfig);
                numberFilesGenerated += objectBuilder.getNumberFilesGenerated();
            }

            for (SchemaQuery query : queries) {
                // crete the directory
                String packageDir = query.getClassName().toLowerCase();

                if (genConfig.isIncludeDatabaseNameInPackage()) {
                    packageDir = database.getName(true).toLowerCase() + "/" + packageDir;
                }

                String outDir = createOutputDir(outputBaseDir, packageDir);

                // package
                String packageName = packageBase + (genConfig.isIncludeDatabaseNameInPackage() ? '.' + database.getName(true).toLowerCase() : "");
                packageName = packageName + "." + query.getClassName().toLowerCase();

                success = objectBuilder.build(database, query, packageName, outDir, genConfig);
                numberFilesGenerated += objectBuilder.getNumberFilesGenerated();
            }

            if (!genConfig.isInjectionSupport()) {
                String packageName = packageBase + (genConfig.isIncludeDatabaseNameInPackage() ? '.' + database.getName(true).toLowerCase() : "");

                String outDir = outputBaseDir;
                if (genConfig.isIncludeDatabaseNameInPackage()) {
                    outDir += "/" + database.getName(true).toLowerCase();
                }

                objectBuilder.buildDatabaseManagersHolder(database, packageBase, packageName, tables, views, queries, outDir);
            }
        }

        return success;
    }

    private String createOutputDir(String baseDir, String name) {
        String outDir = baseDir + "/" + name;
        File newDir = new File(outDir);
        if (!newDir.exists()) {
            newDir.mkdirs();
        }

        return outDir;
    }

    /**
     * Reread xml file
     */
    private void scanXMLFile() {
        File xmlFile = getXmlFile();
        if (xmlFile != null) {
            DBToolsFiles.copyXsdFileToSchemaDir(getXmlFile().getParent());
            schemaRenderer.readXMLSchema(xmlFile.getPath());
        }
    }

    private File getXmlFile() {
        String filename = xmlFilename;
        if (filename != null && !filename.isEmpty()) {
            return new File(filename);
        }

        return null;
    }


    public String getGeneratedPackageName() {
        return PackageUtil.getPackageFromFilePath(outputBaseDir);
    }

    public String getSchemaDatabaseName() {
        return schemaDatabaseName;
    }

    public void setSchemaDatabaseName(String schemaDatabaseName) {
        this.schemaDatabaseName = schemaDatabaseName;
    }

    public List getTables() {
        return tables;
    }

    public void setTables(List tables) {
        this.tables = tables;
    }

    public String getPackageBase() {
        return packageBase;
    }

    public void setPackageBase(String packageBase) {
        this.packageBase = packageBase;
    }

    public String getXmlFilename() {
        return xmlFilename;
    }

    public void setXmlFilename(String xmlFilename) {
        this.xmlFilename = xmlFilename;
        scanXMLFile();
    }

    public String getOutputBaseDir() {
        return outputBaseDir;
    }

    public void setOutputBaseDir(String outputBaseDir) {
        this.outputBaseDir = outputBaseDir;
    }

    public void setGenConfig(GenConfig genConfig) {
        this.genConfig = genConfig;
    }

    public int getNumberFilesGenerated() {
        return numberFilesGenerated;
    }
}