More updates for the new annotated mapper generator

Author: jeffgbutler

mybatis-generator-core/doc/html/configreference/context.html

@@ -144,7 +144,7 @@ <h2>Child Elements</h2>
   <li><a href="jdbcConnection.html">&lt;jdbcConnection&gt;</a> (1 Required)</li>
   <li><a href="javaTypeResolver.html">&lt;javaTypeResolver&gt;</a> (0 or 1)</li>
   <li><a href="javaModelGenerator.html">&lt;javaModelGenerator&gt;</a> (1 Required)</li>
-  <li><a href="sqlMapGenerator.html">&lt;sqlMapGenerator&gt;</a> (1 Required)</li>
+  <li><a href="sqlMapGenerator.html">&lt;sqlMapGenerator&gt;</a> (0 or 1)</li>
   <li><a href="javaClientGenerator.html">&lt;javaClientGenerator&gt;</a> (0 or 1)</li>
   <li><a href="table.html">&lt;table&gt;</a> (1..N)</li>
 </ul>

mybatis-generator-core/doc/html/configreference/javaClientGenerator.html

@@ -43,6 +43,12 @@ <h2>Required Attributes</h2>
           <tr>
             <td colspan="2">If the &lt;context&gt; targetRuntime is <b>MyBatis3</b>:</td>
           <tr>
+          <tr>
+            <th nowrap="nowrap" valign="top">ANNOTATEDMAPPER</th>
+            <td>The generated objects will be Java interfaces for the MyBatis 3.x mapper
+            infrastructure.  The interfaces will be based on annotations and MyBatis 3.x SqlProviders.
+            No XML mapper files will be generated.</td>
+          </tr>
           <tr>
             <th nowrap="nowrap" valign="top">XMLMAPPER</th>
             <td>The generated objects will be Java interfaces for the MyBatis 3.x mapper

mybatis-generator-core/doc/html/configreference/sqlMapGenerator.html

@@ -18,8 +18,12 @@
 <h1>The &lt;sqlMapGenerator&gt; Element</h1>
 <p>The &lt;sqlMapGenerator&gt; element is used to define properties of the SQL map
 generator.  The SQL Map Generator builds a MyBatis/iBATIS formatted SQL map XML file
-for each introspected table. This element is a required child element
+for each introspected table.</p>
+<p>If iBATIS2 is targeted, then this element is a required child element
 of the <a href="context.html">&lt;context&gt;</a> element.</p>
+<p>If MyBatis3 is targeted, then this element is a required child element
+of the <a href="context.html">&lt;context&gt;</a> element only if your chosen
+JavaClientGenerator requires XML, or if you do not specify a JavaClientGenerator.</p>
 <h2>Required Attributes</h2>
 <table border="1" cellspacing="0" cellpadding="5">
   <tr>

mybatis-generator-core/doc/html/whatsNew.html

@@ -28,6 +28,17 @@ <h3>Bugs Fixed</h3>
 </ul>
 <h3>Enhancements</h3>
 <ul>
+  <li>Added a new MyBatis 3 generator that generates code based solely on annotations
+      with no generated XML.  Configuration settings for this new generator are as follows:
+    <ul>
+      <li>The <code>targetRuntime</code> attribute of
+          <a href="configreference/context.html">&lt;context&gt;</a>
+          element is <b>MyBatis3</b></li>
+      <li>The <code>type</code> attribute of
+          <a href="configreference/javaClientGenerator.html">&lt;javaClientGenerator&gt;</a>
+          element is <b>ANNOTATEDMAPPER</b></li>
+    </ul>
+  </li>
   <li>Add support for JDBC types NCHAR, NCLOB, NVARCHAR to match MyBatis3.</li>
   <li>Added support for "useGeneratedKeys" in MyBatis3.  See
       <a href="configreference/generatedKey.html">&lt;generatedKey&gt;</a>

mybatis-generator-core/src/main/java/org/mybatis/generator/api/IntrospectedTable.java

@@ -1094,4 +1094,14 @@ public boolean isConstructorBased() {
 
         return isTrue(properties.getProperty(PropertyRegistry.ANY_CONSTRUCTOR_BASED));
     }
+
+    /**
+     * Should return true if an XML generator is required for this table.
+     * This method will be called during validation of the configuration,
+     * so it should not rely on database introspection.  This method
+     * simply tells the validator if an XML configuration is normally
+     * required for this implementation.
+     * @return
+     */
+    public abstract boolean requiresXMLGenerator();
 }

mybatis-generator-core/src/main/java/org/mybatis/generator/codegen/AbstractJavaClientGenerator.java

@@ -26,8 +26,17 @@
  */
 public abstract class AbstractJavaClientGenerator extends AbstractJavaGenerator {
 
+    private boolean requiresXMLGenerator;
+    
+    public AbstractJavaClientGenerator(boolean requiresXMLGenerator) {
+        super();
+        this.requiresXMLGenerator = requiresXMLGenerator;
+    }
+
     /**
      * @return true if matching XML is required
      */
-    public abstract boolean requiresMatchedXMLGenerator();
+    public boolean requiresXMLGenerator() {
+        return requiresXMLGenerator;
+    }
 }

mybatis-generator-core/src/main/java/org/mybatis/generator/codegen/ibatis2/IntrospectedTableIbatis2Java2Impl.java

@@ -197,4 +197,9 @@ public int getGenerationSteps() {
                                                                       // the
                                                                       // sqlMapGenerator
     }
+
+    @Override
+    public boolean requiresXMLGenerator() {
+        return true;
+    }
 }

mybatis-generator-core/src/main/java/org/mybatis/generator/codegen/ibatis2/dao/DAOGenerator.java

@@ -63,7 +63,7 @@ public class DAOGenerator extends AbstractJavaClientGenerator {
 
     public DAOGenerator(AbstractDAOTemplate daoTemplate,
             boolean generateForJava5) {
-        super();
+        super(true);
         this.daoTemplate = daoTemplate;
         this.generateForJava5 = generateForJava5;
     }
@@ -324,9 +324,4 @@ protected void initializeAndExecuteGenerator(
         methodGenerator.addImplementationElements(topLevelClass);
         methodGenerator.addInterfaceElements(interfaze);
     }
-
-    @Override
-    public boolean requiresMatchedXMLGenerator() {
-        return true;
-    }
 }

mybatis-generator-core/src/main/java/org/mybatis/generator/codegen/mybatis3/IntrospectedTableMyBatis3Impl.java

@@ -77,10 +77,22 @@ protected void calculateXmlMapperGenerator(List<String> warnings,
      */
     protected boolean calculateClientGenerators(List<String> warnings,
             ProgressCallback progressCallback) {
-        if (context.getJavaClientGeneratorConfiguration() == null) {
+        AbstractJavaClientGenerator javaGenerator = createJavaClientGenerator();
+        if (javaGenerator == null) {
             return true;
         }
 
+        initializeAbstractGenerator(javaGenerator, warnings, progressCallback);
+        clientGenerators.add(javaGenerator);
+        
+        return javaGenerator.requiresXMLGenerator();
+    }
+    
+    private AbstractJavaClientGenerator createJavaClientGenerator() {
+        if (context.getJavaClientGeneratorConfiguration() == null) {
+            return null;
+        }
+
         String type = context.getJavaClientGeneratorConfiguration()
                 .getConfigurationType();
 
@@ -95,11 +107,8 @@ protected boolean calculateClientGenerators(List<String> warnings,
             javaGenerator = (AbstractJavaClientGenerator) ObjectFactory
                     .createInternalObject(type);
         }
-
-        initializeAbstractGenerator(javaGenerator, warnings, progressCallback);
-        clientGenerators.add(javaGenerator);
 
-        return javaGenerator.requiresMatchedXMLGenerator();
+        return javaGenerator;
     }
 
     protected void calculateJavaModelGenerators(List<String> warnings,
@@ -199,4 +208,16 @@ public int getGenerationSteps() {
     public boolean isJava5Targeted() {
         return true;
     }
+
+    @Override
+    public boolean requiresXMLGenerator() {
+        AbstractJavaClientGenerator javaClientGenerator =
+            createJavaClientGenerator();
+        
+        if (javaClientGenerator == null) {
+            return true;
+        } else {
+            return javaClientGenerator.requiresXMLGenerator();
+        }
+    }
 }

mybatis-generator-core/src/main/java/org/mybatis/generator/codegen/mybatis3/javamapper/AnnotatedClientGenerator.java

@@ -22,6 +22,10 @@
 
 public class AnnotatedClientGenerator extends JavaMapperGenerator {
 
+    public AnnotatedClientGenerator() {
+        super(false);
+    }
+
     @Override
     protected void addCountByExampleMethod(Interface interfaze) {
         if (introspectedTable.getRules().generateCountByExample()) {
@@ -135,11 +139,6 @@ protected void addUpdateByPrimaryKeyWithoutBLOBsMethod(Interface interfaze) {
         }
     }
 
-    @Override
-    public boolean requiresMatchedXMLGenerator() {
-        return false;
-    }
-
     @Override
     public List<CompilationUnit> getExtraCompilationUnits() {
         SqlProviderGenerator sqlProviderGenerator = new SqlProviderGenerator();