• Home
• com.github.drinkjava2
• enhancedjdbc
• 5.0.7.jre8
• source code
• TableModelUtils.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.drinkjava2.jdialects.TableModelUtils Maven / Gradle / Ivy

/*
 * Copyright 2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
 * applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 */
package com.github.drinkjava2.jdialects;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import javax.sql.DataSource;

import com.github.drinkjava2.jdialects.model.TableModel;

/**
 * This utility tool to translate Entity class / Database metaData / Excel(will
 * add in future) file to TableModel
 *
 * @author Yong Zhu
 * @since 1.0.5
 */
public abstract class TableModelUtils {// NOSONAR
    public static final String OPT_EXCLUDE_TABLES = "excludeTables";
    public static final String OPT_PACKAGE_NAME = "packageName";
    public static final String OPT_IMPORTS = "imports";
    public static final String OPT_REMOVE_DEFAULT_IMPORTS = "removeDefaultImports";//true, false
    public static final String OPT_CLASS_ANNOTATION = "classAnnotationn";
    public static final String OPT_CLASS_DEFINITION = "classDefinition";
    public static final String OPT_FIELD_FLAGS_STATIC = "fieldFlagsStatic"; //true, false    
    public static final String OPT_FIELD_FLAGS = "fieldFlags"; //true, false
    public static final String OPT_FIELD_FLAGS_STYLE = "fieldFlagsStyle"; //upper, normal, lower, camel
    public static final String OPT_PUBLIC_FIELD = "enablePublicField";//true, false
    public static final String OPT_FIELDS = "fields"; //true, false
    public static final String OPT_GETTER_SETTERS = "getterSetters"; //true, false
    public static final String OPT_LINK_STYLE = "linkStyle"; //true, false

    /**
     * Convert tableName to entity class, note: before use this method
     * entity2Models() method should be called first to cache talbeModels in memory
     */
    public static Class tableNameToEntityClass(String tableName) {
        return TableModelUtilsOfEntity.tableNameToEntityClass(tableName);
    }

    /** Convert entity class to a editable TableModel instance */
    public static TableModel entity2Model(Class entityClass) {
        return TableModelUtilsOfEntity.entity2EditableModel(entityClass);
    }

    /** Convert entity classes to editable TableModel instances */
    public static TableModel[] entity2Models(Class... entityClasses) {
        return TableModelUtilsOfEntity.entity2EditableModels(entityClasses);
    }

    /** Convert entity class to a read-only TableModel instance */
    public static TableModel entity2ReadOnlyModel(Class entityClass) {
        return TableModelUtilsOfEntity.entity2ReadOnlyModel(entityClass);
    }

    /** Convert entity classes to read-only TableModel instances */
    public static TableModel[] entity2ReadOnlyModels(Class... entityClasses) {
        return TableModelUtilsOfEntity.entity2ReadOnlyModel(entityClasses);
    }

    /**
     * Convert database metaData to TableModels, note: 

     * 1)This method does not close connection, do not forgot close it later 

     * 2)This method does not read sequence, index, unique constraints
     */
    public static TableModel[] db2Models(Connection con, Dialect dialect) {
        return TableModelUtilsOfDb.db2Models(con, dialect);
    }

    /**
     * Read database structure and write them to Java entity class source code
     *
     * @param ds
     *            The DataSource instance
     * @param dialect
     *            The dialect of database
     * @param outputfolder
     *            the out put folder
     * @param setting
     *            see TableModelUtilsOfJavaSrc.modelToJavaSourceCode() method
     */
    public static void db2JavaSrcFiles(DataSource ds, Dialect dialect, String outputfolder, Map setting) {
        Connection conn = null;
        try {
            conn = ds.getConnection();
            TableModel[] models = db2Models(conn, dialect);
            File dir = new File(outputfolder);
            if (!dir.exists()) {
                dir.mkdirs();
            }
            @SuppressWarnings("unchecked")
            Collection excludeTables = (Collection) setting.get(OPT_EXCLUDE_TABLES);
            if (excludeTables != null) {
                Set t = new HashSet<>();
                for (String s : excludeTables) {
                    t.add(s.trim().toLowerCase());
                }
                excludeTables = t;
            }
            for (TableModel model : models) {
                String tableName = model.getTableName();
                if (excludeTables != null && excludeTables.contains(tableName.toLowerCase())) {
                    continue;
                }

                String filePrefix = (String) setting.get(TableModelUtils.OPT_CLASS_DEFINITION);
                filePrefix = StrUtils.substringBefore(filePrefix, "$");
                filePrefix = StrUtils.substringAfterLast(filePrefix, " ");
                File writename = new File(dir, filePrefix + TableModelUtilsOfJavaSrc.getClassNameFromTableModel(model) + ".java");

                writename.createNewFile();// NOSONAR
                BufferedWriter out = new BufferedWriter(new FileWriter(writename));
                String javaSrc = model2JavaSrc(model, setting);
                out.write(javaSrc);
                out.flush();
                out.close();
            }
        } catch (Exception e) {
            e.printStackTrace();// NOSONAR
            if (conn != null)
                try {
                    conn.close();
                } catch (SQLException e1) {
                    e1.printStackTrace();// NOSONAR
                }
        }
    }

    /**
     * Read database structure and write them to Java entity class source code
     *
     * @param ds
     *            The DataSource instance
     * @param dialect
     *            The dialect of database
     * @param outputfolder
     *            the out put folder
     * @param packageName
     *            package name
     * @param prefix
     *            class prefix, for example: "Q" or "P" 
     */
    public static void db2QClassSrcFiles(DataSource ds, Dialect dialect, String outputFolder, String packageName, String prefix) {
        Map setting = new HashMap();
        setting.put(TableModelUtils.OPT_PACKAGE_NAME, packageName);// 包名
        setting.put(TableModelUtils.OPT_REMOVE_DEFAULT_IMPORTS, true); // 去除自带的imports
        setting.put(TableModelUtils.OPT_CLASS_ANNOTATION, false); // 类上的实体注解
        setting.put(TableModelUtils.OPT_CLASS_DEFINITION, "" + // 
                "public class " + prefix + "$Class {\n" + //
                "\tpublic static final " + prefix + "$Class instance = new " + prefix + "$Class();\n\n" + //
                "\tpublic String toString(){\n" + //
                "\t\treturn \"$table\";\n" + //
                "\t}\n");// 类定义
        setting.put(TableModelUtils.OPT_FIELD_FLAGS, true); // 列名标记
        setting.put(TableModelUtils.OPT_FIELD_FLAGS_STATIC, false); // 列名标记为静态
        setting.put(TableModelUtils.OPT_FIELD_FLAGS_STYLE, "normal"); // 列名可以有normal, upper, lower, camel四种格式
        setting.put(TableModelUtils.OPT_FIELDS, false); // Bean属性这里不需要生成
        TableModelUtils.db2JavaSrcFiles(ds, dialect, outputFolder, setting);
    }

    /**
     * Convert a TablemModel instance to Java entity class source code
     *
     * @param model
     *            The TableModel instance
     * @param setting
     *            see TableModelUtilsOfJavaSrc.modelToJavaSourceCode() method
     * @return class source code
     */
    public static String model2JavaSrc(TableModel model, Map setting) {
        return TableModelUtilsOfJavaSrc.modelToJavaSourceCode(model, setting);
    }

    /**
     * This method bind a tableModel to a entity class, this is a global setting
     */
    public static void bindGlobalModel(Class entityClass, TableModel tableModel) {
        TableModelUtilsOfEntity.globalTableModelCache.put(entityClass, tableModel);
    }

    /** Export entity to excel in csv files    
     * @param pkgName
     * @param fileName
     */
    public static void entityPackage2Excel(String pkgName, String fileName) {
        TableModelUtilsOfExcel.entityPackage2Excel(pkgName, fileName);
    }

    /** Convert entity classes to excel in csv files   
     * @param fileName
     * @param entityClasses
     * @return
     */
    public static void entity2Excel(String fileName, Class... entityClasses) {
        TableModelUtilsOfExcel.model2Excel(fileName, TableModelUtils.entity2Models(entityClasses));
    }

    /**
    * Export entity to excel csv files 
     * @param con
     * @param dialect
     * @param fileName
     */
    public static void db2Excel(Connection con, Dialect dialect, String fileName) {
        TableModel[] models = TableModelUtilsOfDb.db2Models(con, dialect);
        TableModelUtilsOfExcel.model2Excel(fileName, models);
    }
}