Reworked documentation: added documentation for new features etc.

[hibernate4-maven-plugin] / src / main / java / de / juplo / plugins / hibernate4 / Hbm2DdlMojo.java

diff --git a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java
index e7aa154..3b3a72b 100644 (file)
--- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java
+++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java
@@ -82,6 +82,8 @@ public class Hbm2DdlMojo extends AbstractMojo
 
   /**
    * The maven project.
+   * <p>
+   * Only needed internally.
    *
    * @parameter expression="${project}"
    * @required
@@ -91,20 +93,58 @@ public class Hbm2DdlMojo extends AbstractMojo
 
   /**
    * Build-directory.
+   * <p>
+   * Only needed internally.
    *
    * @parameter expression="${project.build.directory}"
+   * @required
+   * @readonly
    */
   private String buildDirectory;
 
   /**
-   * Class-directory to scan.
+   * Classes-Directory to scan.
+   * <p>
+   * This parameter defaults to the maven build-output-directory for classes.
+   * Additonally, all dependencies are scanned for annotated classes.
    *
    * @parameter expression="${project.build.outputDirectory}"
    */
   private String outputDirectory;
 
+  /**
+   * Wether to scan test-classes too, or not.
+   * <p>
+   * If this parameter is set to <code>true</code> the test-classes of the
+   * artifact will be scanned for hibernate-annotated classes additionally.
+   *
+   * @parameter expression="${hibernate.export.scann_testclasses}" default-value="false"
+   */
+  private boolean scanTestClasses;
+
+  /**
+   * Test-Classes-Directory to scan.
+   * <p>
+   * This parameter defaults to the maven build-output-directory for
+   * test-classes.
+   * <p>
+   * This parameter is only used, when <code>scanTestClasses</code> is set
+   * to <code>true</code>!
+   *
+   * @parameter expression="${project.build.testOutputDirectory}"
+   */
+  private String testOutputDirectory;
+
   /**
    * Skip execution
+   * <p>
+   * If set to <code>true</code>, the execution is skipped.
+   * <p>
+   * A skipped excecution is signaled via the maven-property
+   * <code>${hibernate.export.skipped}</code>.
+   * <p>
+   * The excecution is skipped automatically, if no modified or newly added
+   * annotated classes are found and the dialect was not changed.
    *
    * @parameter expression="${maven.test.skip}" default-value="false"
    */
@@ -114,7 +154,9 @@ public class Hbm2DdlMojo extends AbstractMojo
    * Force execution
    * <p>
    * Force execution, even if no modified or newly added annotated classes
-   * where found. <code>skip</code> takes precedence over <code>force</code>.
+   * where found and the dialect was not changed.
+   * <p>
+   * <code>skip</code> takes precedence over <code>force</code>.
    *
    * @parameter expression="${hibernate.export.force}" default-value="false"
    */
@@ -165,8 +207,8 @@ public class Hbm2DdlMojo extends AbstractMojo
   /**
    * Target of execution:
    * <ul>
-   *   <li><strong>NONE</strong> do nothing - just validate the configuration</li>
-   *   <li><strong>EXPORT</strong> create database <strong>(DEFAULT!)</strong></li>
+   *   <li><strong>NONE</strong> do nothing - just validate the configuration (forces excecution, signals skip)</li>
+   *   <li><strong>EXPORT</strong> create database (<strong>DEFAULT!</strong>. forces excecution, signals skip)</li>
    *   <li><strong>SCRIPT</strong> export schema to SQL-script</li>
    *   <li><strong>BOTH</strong></li>
    * </ul>
@@ -175,12 +217,12 @@ public class Hbm2DdlMojo extends AbstractMojo
   private String target;
 
   /**
-   * Type of export.
+   * Type of execution.
    * <ul>
    *   <li><strong>NONE</strong> do nothing - just validate the configuration</li>
    *   <li><strong>CREATE</strong> create database-schema</li>
    *   <li><strong>DROP</strong> drop database-schema</li>
-   *   <li><strong>BOTH</strong> <strong>(DEFAULT!)</strong></li>
+   *   <li><strong>BOTH</strong> (<strong>DEFAULT!</strong>)</li>
    * </ul>
    * @parameter expression="${hibernate.export.type}" default-value="BOTH"
    */
@@ -262,6 +304,8 @@ public class Hbm2DdlMojo extends AbstractMojo
     {
       getLog().debug("Creating ClassLoader for project-dependencies...");
       List<String> classpathFiles = project.getCompileClasspathElements();
+      if (scanTestClasses)
+        classpathFiles.addAll(project.getTestClasspathElements());
       URL[] urls = new URL[classpathFiles.size()];
       for (int i = 0; i < classpathFiles.size(); ++i)
       {
@@ -293,6 +337,15 @@ public class Hbm2DdlMojo extends AbstractMojo
       getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
       URL dirUrl = dir.toURI().toURL();
       db.scanArchives(dirUrl);
+      if (scanTestClasses)
+      {
+        dir = new File(testOutputDirectory);
+        if (!dir.exists())
+          throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!");
+        getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
+        dirUrl = dir.toURI().toURL();
+        db.scanArchives(dirUrl);
+      }
 
       Set<String> classNames = new HashSet<String>();
       if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
@@ -527,17 +580,28 @@ public class Hbm2DdlMojo extends AbstractMojo
             case CREATE:
             case DROP:
             case BOTH:
-              Class driverClass = classLoader.loadClass(driverClassName);
+              Class driverClass = classLoader.loadClass(properties.getProperty(DRIVER_CLASS));
               getLog().debug("Registering JDBC-driver " + driverClass.getName());
               DriverManager.registerDriver(new DriverProxy((Driver)driverClass.newInstance()));
-              getLog().debug("Opening JDBC-connection to " + url + " as " + username + " with password " + password);
-              connection = DriverManager.getConnection(url, username, password);
+              getLog().debug(
+                  "Opening JDBC-connection to "
+                  + properties.getProperty(URL)
+                  + " as "
+                  + properties.getProperty(USERNAME)
+                  + " with password "
+                  + properties.getProperty(PASSWORD)
+                  );
+              connection = DriverManager.getConnection(
+                  properties.getProperty(URL),
+                  properties.getProperty(USERNAME),
+                  properties.getProperty(PASSWORD)
+                  );
           }
       }
     }
     catch (ClassNotFoundException e)
     {
-      getLog().error("Dependency for driver-class " + driverClassName + " is missing!");
+      getLog().error("Dependency for driver-class " + properties.getProperty(DRIVER_CLASS) + " is missing!");
       throw new MojoExecutionException(e.getMessage());
     }
     catch (Exception e)