Docs

Author: jeffgbutler

src/site/markdown/docs/mybatis3.md

@@ -0,0 +1,58 @@
+# Specialized Support for MyBatis3
+Most of the examples shown on this site are for usage with MyBatis3.  But the library does have some additional support for MyBatis3 beyond what is shown in the other examples.
+
+This support is added to the DELETE, SELECT, and UPDATE statement generators and enables the creating of reusable "by example" methods as delivered in MyBatis Generator.  These methods can provide some boilerplate code for the setup of the statement (a column list and table name for example), and allow the user to specify a where clause.
+
+For example, it is possible to write a mapper like this:
+
+```java
+import static examples.simple.SimpleTableDynamicSqlSupport.*;
+
+import java.util.List;
+
+import org.apache.ibatis.annotations.Mapper;
+import org.apache.ibatis.annotations.Result;
+import org.apache.ibatis.annotations.Results;
+import org.apache.ibatis.annotations.SelectProvider;
+import org.apache.ibatis.type.JdbcType;
+import org.mybatis.dynamic.sql.select.MyBatis3SelectModelAdapter;
+import org.mybatis.dynamic.sql.select.QueryExpressionDSL;
+import org.mybatis.dynamic.sql.select.SelectDSL;
+import org.mybatis.dynamic.sql.select.render.SelectStatement;
+import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
+
+@Mapper
+public interface SimpleTableAnnotatedMapper {
+    
+    @SelectProvider(type=SqlProviderAdapter.class, method="select")
+    @Results(id="SimpleTableResult", value= {
+            @Result(column="A_ID", property="id", jdbcType=JdbcType.INTEGER, id=true),
+            @Result(column="first_name", property="firstName", jdbcType=JdbcType.VARCHAR),
+            @Result(column="last_name", property="lastName", jdbcType=JdbcType.VARCHAR),
+            @Result(column="birth_date", property="birthDate", jdbcType=JdbcType.DATE),
+            @Result(column="employed", property="employed", jdbcType=JdbcType.VARCHAR, typeHandler=YesNoTypeHandler.class),
+            @Result(column="occupation", property="occupation", jdbcType=JdbcType.VARCHAR)
+    })
+    List<SimpleTableRecord> selectMany(SelectStatement selectStatement);
+    
+    default QueryExpressionDSL<MyBatis3SelectModelAdapter<List<SimpleTableRecord>>>.QueryExpressionAfterFrom selectByExample() {
+        return SelectDSL.select(this::selectMany, id.as("A_ID"), firstName, lastName, birthDate, employed, occupation)
+            .from(simpleTable);
+    }
+    
+}
+```
+
+Notice the `selectByExample` method - it specifies the column list and table name and returns the intermediate builder that can be used to finish the WHERE clause.  It also reuses the `selectMany` mapper method.  Mapper methods built using this added support all finish with an `execute` method that builds the statement and executes the mapper method.
+
+The code is used like this:
+
+```java
+    List<SimpleTableRecord> rows = mapper.selectByExample()
+            .where(id, isEqualTo(1))
+            .or(occupation, isNull())
+            .build()
+            .execute();
+```
+
+It is expected that a future version of MyBatis Generator will generate code that looks like this.

src/site/site.xml

@@ -41,6 +41,7 @@
       <item href="docs/delete.html" name="DELETE Statements" />
       <item href="docs/insert.html" name="INSERT Statements" />
       <item href="docs/update.html" name="UPDATE Statements" />
+      <item href="docs/mybatis3.html" name="MyBatis3 Support" />
       <item href="docs/spring.html" name="Spring Support" />
       <item href="docs/howItWorks.html" name="How it Works" />
       <item href="docs/extending.html" name="Extending the Library" />