com.querydsl.sql.codegen.ant.AntMetaDataExporter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * 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.querydsl.sql.codegen.ant;

import com.querydsl.codegen.BeanSerializer;
import com.querydsl.codegen.Property;
import com.querydsl.codegen.Serializer;
import com.querydsl.sql.codegen.DefaultNamingStrategy;
import com.querydsl.sql.codegen.MetaDataExporter;
import com.querydsl.sql.codegen.MetadataExporterConfig;
import com.querydsl.sql.codegen.NamingStrategy;
import com.querydsl.sql.codegen.support.CustomType;
import com.querydsl.sql.codegen.support.NumericMapping;
import com.querydsl.sql.codegen.support.RenameMapping;
import com.querydsl.sql.codegen.support.TypeMapping;
import java.io.File;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;

/**
 * {@code AntMetaDataExporter} exports JDBC metadata to Querydsl query types
 *
 * @author tiwe
 */
public class AntMetaDataExporter extends Task implements MetadataExporterConfig {

  /** JDBC driver class name */
  private String jdbcDriver;

  /** JDBC connection url */
  private String jdbcUrl;

  /** JDBC connection username */
  private String jdbcUser;

  /** JDBC connection password */
  private String jdbcPassword;

  /** name prefix for querydsl-types (default: "Q") */
  private String namePrefix;

  /** name suffix for querydsl-types (default: "") */
  private String nameSuffix;

  /** name prefix for bean types (default: "") */
  private String beanPrefix;

  /** name suffix for bean types (default: "") */
  private String beanSuffix;

  /** package name for sources */
  private String packageName;

  /** package name for bean sources (default: packageName) */
  private String beanPackageName;

  /**
   * schemaPattern a schema name pattern; must match the schema name as it is stored in the
   * database; "" retrieves those without a schema; {@code null} means that the schema name should
   * not be used to narrow the search (default: null)
   */
  private String schemaPattern;

  private String catalogPattern;

  /**
   * tableNamePattern a table name pattern; must match the table name as it is stored in the
   * database (default: null)
   */
  private String tableNamePattern;

  /** target source folder to create the sources into (e.g. target/generated-sources/java) */
  private String targetFolder;

  /** target source folder to create the bean sources into */
  private String beansTargetFolder;

  /** naming strategy class to override (default: DefaultNamingStrategy) */
  private String namingStrategyClass = DefaultNamingStrategy.class.getName();

  /** bean serializer class (default: BeanSerializer) */
  private String beanSerializerClass = BeanSerializer.class.getName();

  /** serializer class to override */
  private String serializerClass;

  /** serialize beans as well */
  private boolean exportBeans;

  /** additional bean interfaces */
  private String[] beanInterfaces;

  /** toString() method addition to beans */
  private boolean beanAddToString;

  /** full constructor addition to beans */
  private boolean beanAddFullConstructor;

  /** use supertype in beans */
  private boolean beanPrintSupertype;

  /** wrap key properties into inner classes (default: false) */
  private boolean innerClassesForKeys;

  /** export validation annotations (default: false) */
  private boolean validationAnnotations;

  /** export column annotations (default: false) */
  private boolean columnAnnotations;

  /** custom types to use */
  private List customTypes = new ArrayList<>();

  /** scala generation mode */
  private boolean createScalaSources;

  /** append schema name to package */
  private boolean schemaToPackage;

  /** lower case normalization of names */
  private boolean lowerCase;

  /** export tables */
  private boolean exportTables = true;

  /** export views */
  private boolean exportViews = true;

  /** export all */
  private boolean exportAll;

  /** export primary keys */
  private boolean exportPrimaryKeys = true;

  /** export foreign keys */
  private boolean exportForeignKeys = true;

  /** export direct foreign keys */
  private boolean exportDirectForeignKeys = true;

  /** export inverse foreign keys */
  private boolean exportInverseForeignKeys = true;

  /** override default column order (default: alphabetical) */
  private String columnComparatorClass;

  /**
   * Comma-separated list of table types to export (allowable values will depend on JDBC driver).
   * Allows for arbitrary set of types to be exported, e.g.: "TABLE, MATERIALIZED VIEW". The
   * exportTables and exportViews parameters will be ignored if this parameter is set. (default:
   * none)
   */
  private String tableTypesToExport;

  /**
   * java import added to generated query classes: com.bar for package (without .* notation)
   * com.bar.Foo for class
   */
  private String[] imports;

  // Ant only
  private String sourceEncoding;

  /** custom type mappings to use */
  private List typeMappings = new ArrayList<>();

  /** custom numeric mappings */
  private List numericMappings = new ArrayList<>();

  /** custom rename mappings */
  private List renameMappings = new ArrayList<>();

  @Override
  @SuppressWarnings({"unchecked", "rawtypes"})
  public void execute() {
    if (targetFolder == null) {
      throw new BuildException("targetFolder is a mandatory property");
    }

    Connection dbConn = null;
    try {
      Class.forName(jdbcDriver).newInstance();

      dbConn = DriverManager.getConnection(jdbcUrl, jdbcUser, jdbcPassword);

      var exporter = new MetaDataExporter(this);

      exporter.export(dbConn.getMetaData());

    } catch (RuntimeException
        | SQLException
        | ClassNotFoundException
        | IllegalAccessException
        | InstantiationException e) {
      throw new BuildException(e);
    } finally {
      if (dbConn != null) {
        try {
          dbConn.close();
        } catch (SQLException e2) {
          throw new BuildException(e2);
        }
      }
    }
  }

  public String getJdbcDriver() {
    return jdbcDriver;
  }

  public void setJdbcDriver(String jdbcDriver) {
    this.jdbcDriver = jdbcDriver;
  }

  public String getJdbcUrl() {
    return jdbcUrl;
  }

  public void setJdbcUrl(String jdbcUrl) {
    this.jdbcUrl = jdbcUrl;
  }

  public String getJdbcUser() {
    return jdbcUser;
  }

  public void setJdbcUser(String jdbcUser) {
    this.jdbcUser = jdbcUser;
  }

  public String getJdbcPassword() {
    return jdbcPassword;
  }

  public void setJdbcPassword(String jdbcPassword) {
    this.jdbcPassword = jdbcPassword;
  }

  @Override
  public String getNamePrefix() {
    return namePrefix;
  }

  public void setNamePrefix(String namePrefix) {
    this.namePrefix = namePrefix;
  }

  @Override
  public String getNameSuffix() {
    return nameSuffix;
  }

  public void setNameSuffix(String nameSuffix) {
    this.nameSuffix = nameSuffix;
  }

  @Override
  public String getBeanPrefix() {
    return beanPrefix;
  }

  public void setBeanPrefix(String beanPrefix) {
    this.beanPrefix = beanPrefix;
  }

  @Override
  public String getBeanSuffix() {
    return beanSuffix;
  }

  public void setBeanSuffix(String beanSuffix) {
    this.beanSuffix = beanSuffix;
  }

  @Override
  public String getPackageName() {
    return packageName;
  }

  public void setPackageName(String packageName) {
    this.packageName = packageName;
  }

  @Override
  public String getBeanPackageName() {
    return beanPackageName;
  }

  public void setBeanPackageName(String beanPackageName) {
    this.beanPackageName = beanPackageName;
  }

  @Override
  public String getSchemaPattern() {
    return schemaPattern;
  }

  public void setSchemaPattern(String schemaPattern) {
    this.schemaPattern = schemaPattern;
  }

  @Override
  public String getTableNamePattern() {
    return tableNamePattern;
  }

  public void setTableNamePattern(String tableNamePattern) {
    this.tableNamePattern = tableNamePattern;
  }

  @Override
  public File getTargetFolder() {
    return new File(targetFolder);
  }

  public void setTargetFolder(String targetFolder) {
    this.targetFolder = targetFolder;
  }

  @Override
  public Class getNamingStrategyClass() {
    if (namingStrategyClass == null) {
      return null;
    }
    try {
      return (Class) Class.forName(namingStrategyClass);
    } catch (ClassNotFoundException e) {
      throw new RuntimeException(e);
    }
  }

  public void setNamingStrategyClass(String namingStrategyClass) {
    this.namingStrategyClass = namingStrategyClass;
  }

  @Override
  public Class getBeanSerializerClass() {
    if (exportBeans && beanSerializerClass != null) {
      try {
        return (Class) Class.forName(beanSerializerClass);
      } catch (ClassNotFoundException e) {
        throw new RuntimeException(e);
      }
    }
    return null;
  }

  public void setBeanSerializerClass(String beanSerializerClass) {
    this.beanSerializerClass = beanSerializerClass;
  }

  @Override
  public Class getSerializerClass() {
    if (serializerClass == null) {
      return null;
    }
    try {
      return (Class) Class.forName(serializerClass);
    } catch (ClassNotFoundException e) {
      throw new RuntimeException(e);
    }
  }

  public void setSerializerClass(String serializerClass) {
    this.serializerClass = serializerClass;
  }

  @Override
  public boolean isExportBeans() {
    return exportBeans;
  }

  public void setExportBeans(boolean exportBeans) {
    this.exportBeans = exportBeans;
  }

  @Override
  public String[] getBeanInterfaces() {
    return beanInterfaces;
  }

  public void setBeanInterfaces(String[] beanInterfaces) {
    this.beanInterfaces = beanInterfaces;
  }

  @Override
  public boolean isBeanAddToString() {
    return beanAddToString;
  }

  public void setBeanAddToString(boolean beanAddToString) {
    this.beanAddToString = beanAddToString;
  }

  @Override
  public boolean isBeanAddFullConstructor() {
    return beanAddFullConstructor;
  }

  public void setBeanAddFullConstructor(boolean beanAddFullConstructor) {
    this.beanAddFullConstructor = beanAddFullConstructor;
  }

  @Override
  public boolean isBeanPrintSupertype() {
    return beanPrintSupertype;
  }

  public void setBeanPrintSupertype(boolean beanPrintSupertype) {
    this.beanPrintSupertype = beanPrintSupertype;
  }

  @Override
  public boolean isInnerClassesForKeys() {
    return innerClassesForKeys;
  }

  public void setInnerClassesForKeys(boolean innerClassesForKeys) {
    this.innerClassesForKeys = innerClassesForKeys;
  }

  @Override
  public boolean isValidationAnnotations() {
    return validationAnnotations;
  }

  public void setValidationAnnotations(boolean validationAnnotations) {
    this.validationAnnotations = validationAnnotations;
  }

  @Override
  public boolean isColumnAnnotations() {
    return columnAnnotations;
  }

  public void setColumnAnnotations(boolean columnAnnotations) {
    this.columnAnnotations = columnAnnotations;
  }

  /** Adds custom type to ant */
  public void addCustomType(CustomType customType) {
    customTypes.add(customType);
  }

  /**
   * Gets a list of custom types
   *
   * @return a list of custom types
   * @deprecated Use addCustomType instead
   */
  @Deprecated
  @Override
  public List getCustomTypes() {
    return this.customTypes;
  }

  /**
   * Sets a list of custom types
   *
   * @param strings a list of custom types
   * @deprecated Use addCustomType instead
   */
  @Deprecated
  public void setCustomTypes(String[] strings) {
    this.customTypes.clear();
    for (String string : strings) {
      var customType = new CustomType();
      customType.setClassName(string);
      this.customTypes.add(customType);
    }
  }

  public void setCreateScalaSources(boolean createScalaSources) {
    this.createScalaSources = createScalaSources;
  }

  @Override
  public boolean isSchemaToPackage() {
    return schemaToPackage;
  }

  public void setSchemaToPackage(boolean schemaToPackage) {
    this.schemaToPackage = schemaToPackage;
  }

  @Override
  public boolean isLowerCase() {
    return lowerCase;
  }

  public void setLowerCase(boolean lowerCase) {
    this.lowerCase = lowerCase;
  }

  @Override
  public boolean isExportTables() {
    return exportTables;
  }

  public void setExportTables(boolean exportTables) {
    this.exportTables = exportTables;
  }

  @Override
  public boolean isExportViews() {
    return exportViews;
  }

  public void setExportViews(boolean exportViews) {
    this.exportViews = exportViews;
  }

  @Override
  public boolean isExportAll() {
    return exportAll;
  }

  public void setExportAll(boolean exportAll) {
    this.exportAll = exportAll;
  }

  @Override
  public boolean isExportPrimaryKeys() {
    return exportPrimaryKeys;
  }

  public void setExportPrimaryKeys(boolean exportPrimaryKeys) {
    this.exportPrimaryKeys = exportPrimaryKeys;
  }

  @Override
  public boolean isExportForeignKeys() {
    return exportForeignKeys;
  }

  @Override
  public boolean isExportDirectForeignKeys() {
    return exportDirectForeignKeys;
  }

  public void setExportDirectForeignKeys(boolean exportDirectForeignKeys) {
    this.exportDirectForeignKeys = exportDirectForeignKeys;
  }

  @Override
  public boolean isExportInverseForeignKeys() {
    return exportInverseForeignKeys;
  }

  public void setExportInverseForeignKeys(boolean exportInverseForeignKeys) {
    this.exportInverseForeignKeys = exportInverseForeignKeys;
  }

  public void setExportForeignKeys(boolean exportForeignKeys) {
    this.exportForeignKeys = exportForeignKeys;
  }

  @Override
  public Class> getColumnComparatorClass() {
    if (columnComparatorClass == null) {
      return null;
    }
    try {
      return (Class>) Class.forName(columnComparatorClass);
    } catch (ClassNotFoundException e) {
      throw new RuntimeException(e);
    }
  }

  public void setColumnComparatorClass(String columnComparatorClass) {
    this.columnComparatorClass = columnComparatorClass;
  }

  @Override
  public String getTableTypesToExport() {
    return tableTypesToExport;
  }

  public void setTableTypesToExport(String tableTypesToExport) {
    this.tableTypesToExport = tableTypesToExport;
  }

  @Override
  public List getImports() {
    if (imports == null) {
      return null;
    }
    return Arrays.asList(imports);
  }

  public void setImports(String[] imports) {
    this.imports = imports;
  }

  @Override
  public Charset getSourceEncoding() {
    if (sourceEncoding != null) {
      return Charset.forName(sourceEncoding);
    }

    return StandardCharsets.UTF_8;
  }

  public void setSourceEncoding(String sourceEncoding) {
    this.sourceEncoding = sourceEncoding;
  }

  @Override
  public File getBeansTargetFolder() {
    if (beansTargetFolder != null) {
      return new File(beansTargetFolder);
    }
    return null;
  }

  public void setBeansTargetFolder(String beansTargetFolder) {
    this.beansTargetFolder = beansTargetFolder;
  }

  /** Adds TypeMapping instance, called by Ant */
  public void addTypeMapping(TypeMapping mapping) {
    typeMappings.add(mapping);
  }

  /** Adds NumericMapping instance, called by Ant */
  public void addNumericMapping(NumericMapping mapping) {
    numericMappings.add(mapping);
  }

  /** Adds RenameMapping instance, called by Ant */
  public void addRenameMapping(RenameMapping mapping) {
    renameMappings.add(mapping);
  }

  @Override
  public boolean isCreateScalaSources() {
    return createScalaSources;
  }

  @Override
  public String getCatalogPattern() {
    return catalogPattern;
  }

  public void setCatalogPattern(String catalogPattern) {
    this.catalogPattern = catalogPattern;
  }

  @Override
  public String getGeneratedAnnotationClass() {
    return null;
  }

  @Override
  public List getTypeMappings() {
    return typeMappings;
  }

  @Override
  public List getNumericMappings() {
    return numericMappings;
  }

  @Override
  public List getRenameMappings() {
    return renameMappings;
  }
}