Say goodbye to "by example"

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3CountByExampleHelper.java renamed to src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3CountHelper.java

@@ -22,7 +22,7 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 
 /**
- * Represents a function that can be used to create a "CountByExample" method in the style
+ * Represents a function that can be used to create a general count method in the style
  * of MyBatis Generator. When using this function, you can create a method that does not require a user to
  * call the build().execute() methods - making client code look a bit cleaner.
  * 
@@ -32,7 +32,7 @@
  * @SelectProvider(type=SqlProviderAdapter.class, method="select")
  * long count(SelectStatementProvider selectStatement);
  *   
- * default long countByExample(MyBatis3CountByExampleHelper helper) {
+ * default long count(MyBatis3CountHelper helper) {
  *     return helper.apply(SelectDSL.selectWithMapper(this::count, SqlBuilder.count())
  *             .from(simpleTable))
  *             .build()
@@ -43,34 +43,34 @@
  * <p>And then call the simplified default method like this:
  * 
  * <pre>
- * long rows = mapper.countByExample(q -&gt;
+ * long rows = mapper.count(q -&gt;
  *         q.where(occupation, isNull()));
  * </pre>
  * 
  * <p>You can implement a "count all" with the following code:
  * 
  * <pre>
- * long rows = mapper.countByExample(q -&gt; q);
+ * long rows = mapper.count(q -&gt; q);
  * </pre>
  * 
  * <p>Or
  * 
  * <pre>
- * long rows = mapper.countByExample(MyBatis3CountByExampleHelper.allRows());
+ * long rows = mapper.count(MyBatis3CountHelper.allRows());
  * </pre>
  *  
  * @author Jeff Butler
  */
 @FunctionalInterface
-public interface MyBatis3CountByExampleHelper extends
+public interface MyBatis3CountHelper extends
         Function<QueryExpressionDSL<MyBatis3SelectModelAdapter<Long>>, Buildable<MyBatis3SelectModelAdapter<Long>>> {
 
     /**
      * Returns a helper that can be used to count every row in a table.
      * 
      * @return the helper that will count every row in a table
      */
-    static MyBatis3CountByExampleHelper allRows() {
+    static MyBatis3CountHelper allRows() {
         return h -> h;
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3DeleteByExampleHelper.java renamed to src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3DeleteHelper.java

@@ -22,7 +22,7 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 
 /**
- * Represents a function that can be used to create a "DeleteByExample" method in the style
+ * Represents a function that can be used to create a general delete method in the style
  * of MyBatis Generator. When using this function, you can create a method that does not require a user to
  * call the build().execute() methods - making client code look a bit cleaner.
  * 
@@ -32,7 +32,7 @@
  * @DeleteProvider(type=SqlProviderAdapter.class, method="delete")
  * int delete(DeleteStatementProvider deleteStatement);
  *   
- * default int deleteByExample(MyBatis3DeleteByExampleHelper helper) {
+ * default int delete(MyBatis3DeleteHelper helper) {
  *     return helper.apply(DeleteDSL.deleteFromWithMapper(this::delete, simpleTable))
  *           .build()
  *           .execute();
@@ -42,34 +42,34 @@
  * <p>And then call the simplified default method like this:
  * 
  * <pre>
- * int rows = mapper.deleteByExample(q -&gt;
+ * int rows = mapper.delete(q -&gt;
  *           q.where(occupation, isNull()));
  * </pre>
  *  
  * <p>You can implement a "delete all" with the following code:
  * 
  * <pre>
- * int rows = mapper.deleteByExample(q -&gt; q);
+ * int rows = mapper.delete(q -&gt; q);
  * </pre>
  * 
  * <p>Or
  * 
  * <pre>
- * long rows = mapper.deleteByExample(MyBatis3DeleteByExampleHelper.allRows());
+ * long rows = mapper.delete(MyBatis3DeleteHelper.allRows());
  * </pre>
 
  * @author Jeff Butler
  */
 @FunctionalInterface
-public interface MyBatis3DeleteByExampleHelper extends
+public interface MyBatis3DeleteHelper extends
         Function<DeleteDSL<MyBatis3DeleteModelAdapter<Integer>>, Buildable<MyBatis3DeleteModelAdapter<Integer>>> {
 
     /**
      * Returns a helper that can be used to delete every row in a table.
      * 
      * @return the helper that will delete every row in a table
      */
-    static MyBatis3DeleteByExampleHelper allRows() {
+    static MyBatis3DeleteHelper allRows() {
         return h -> h;
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3SelectByExampleHelper.java renamed to src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3SelectHelper.java

@@ -24,7 +24,7 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 
 /**
- * Represents a function that can be used to create a "SelectByExample" method in the style
+ * Represents a function that can be used to create a general select method in the style
  * of MyBatis Generator. When using this function, you can create a method that does not require a user to
  * call the build().execute() methods - making client code look a bit cleaner.
  * 
@@ -42,7 +42,7 @@
  * })
  * List<SimpleRecord> selectMany(SelectStatementProvider selectStatement);
  *
- * default List<SimpleRecord> selectByExample(MyBatis3SelectByExampleHelper<SimpleRecord> helper) {
+ * default List<SimpleRecord> select(MyBatis3SelectHelper<SimpleRecord> helper) {
  *     return helper.apply(SelectDSL.selectWithMapper(this::selectMany, simpleTable.allColumns())
  *             .from(simpleTable))
  *             .build()
@@ -53,27 +53,27 @@
  * <p>And then call the simplified default method like this:
  * 
  * <pre>
- * List&lt;SimpleRecord&gt; rows = mapper.selectByExample(q -&gt;
+ * List&lt;SimpleRecord&gt; rows = mapper.select(q -&gt;
  *     q.where(id, isEqualTo(1))
  *     .or(occupation, isNull()));
  * </pre>
  *  
  * <p>You can implement a "select all" with the following code:
  * 
  * <pre>
- * List&lt;SimpleRecord&gt; rows = mapper.selectByExample(q -&gt; q);
+ * List&lt;SimpleRecord&gt; rows = mapper.select(q -&gt; q);
  * </pre>
  * 
  * <p>Or
  * 
  * <pre>
- * List&lt;SimpleRecord&gt; rows = mapper.selectByExample(MyBatis3SelectByExampleHelper.allRows());
+ * List&lt;SimpleRecord&gt; rows = mapper.select(MyBatis3SelectHelper.allRows());
  * </pre>
  * 
  * @author Jeff Butler
  */
 @FunctionalInterface
-public interface MyBatis3SelectByExampleHelper<T> extends
+public interface MyBatis3SelectHelper<T> extends
         Function<QueryExpressionDSL<MyBatis3SelectModelAdapter<List<T>>>,
         Buildable<MyBatis3SelectModelAdapter<List<T>>>> {
 
@@ -84,7 +84,7 @@ public interface MyBatis3SelectByExampleHelper<T> extends
      * 
      * @return the helper that will select every row in a table
      */
-    static <T> MyBatis3SelectByExampleHelper<T> allRows() {
+    static <T> MyBatis3SelectHelper<T> allRows() {
         return h -> h;
     }
 
@@ -96,7 +96,7 @@ static <T> MyBatis3SelectByExampleHelper<T> allRows() {
      * 
      * @return the helper that will select every row in a table in the specified order
      */
-    static <T> MyBatis3SelectByExampleHelper<T> allRowsOrderdBy(SortSpecification...columns) {
+    static <T> MyBatis3SelectHelper<T> allRowsOrderdBy(SortSpecification...columns) {
         return h -> h.orderBy(columns);
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3UpdateByExampleHelper.java renamed to src/main/java/org/mybatis/dynamic/sql/util/mybatis3/MyBatis3UpdateHelper.java

@@ -22,7 +22,7 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 
 /**
- * Represents a function that can be used to create a multi-purpose update method in the style
+ * Represents a function that can be used to create a general update method in the style
  * of MyBatis Generator. When using this function, you can create a method that does not require a user to
  * call the build().execute() methods - making client code look a bit cleaner.
  * 
@@ -32,7 +32,7 @@
  * @UpdateProvider(type=SqlProviderAdapter.class, method="update")
  * int update(UpdateStatementProvider updateStatement);
  *   
- * default int update(MyBatis3UpdateByExampleHelper helper) {
+ * default int update(MyBatis3UpdateHelper helper) {
  *     return helper.apply(UpdateDSL.updateWithMapper(this::update, simpleTable))
  *             .build()
  *             .execute();
@@ -42,29 +42,49 @@
  * <p>And then call the simplified default method like this:
  * 
  * <pre>
- * int rows = mapper.updateByExampleSelective(q -&gt;
- *                q.where(id, isEqualTo(100))
- *                .and(firstName, isEqualTo("Joe")))
- *                .usingRecord(record);
+ * int rows = mapper.update(q -&gt;
+ *                q.set(firstName).equalTo("Fred")
+ *                .where(id, isEqualTo(100))
+ *            );
  * </pre>
  *  
- * <p>You can implement an "update all" with the following code:
+ * <p>You can implement an "update all" simply by omitting a where clause:
  * 
  * <pre>
- * int rows = mapper.updateByExampleSelective(q -&gt; q)
- *                .usingRecord(record);
+ * int rows = mapper.update(q -&gt;
+ *                q.set(firstName).equalTo("Fred")
+ *            );
  * </pre>
  * 
- * <p>Or
+ * <p>You could also implement a helper method that would set fields based on values of a record. For example,
+ * the following method would set all fields of a record based on whether or not the values are null:
  * 
  * <pre>
- * int rows = mapper.updateByExampleSelective(MyBatis3UpdateByExampleHelper.allRows())
- *                .usingRecord(record);
+ * static UpdateDSL&lt;MyBatis3UpdateModelAdapter&lt;Integer&gt;&gt; setSelective(SimpleTableRecord record,
+ *         UpdateDSL&lt;MyBatis3UpdateModelAdapter&lt;Integer&gt;&gt; dsl) {
+ *     return dsl.set(id).equalToWhenPresent(record::getId)
+ *             .set(firstName).equalToWhenPresent(record::getFirstName)
+ *             .set(lastName).equalToWhenPresent(record::getLastName)
+ *             .set(birthDate).equalToWhenPresent(record::getBirthDate)
+ *             .set(employed).equalToWhenPresent(record::getEmployed)
+ *             .set(occupation).equalToWhenPresent(record::getOccupation);
+ * }
+ * </pre>
+ * 
+ * <p>The helper method could be used like this:
+ * 
+ * <pre>
+ * rows = mapper.update(dsl -&gt;
+ *        SimpleTableAnnotatedMapperNewStyle.setSelective(record, dsl)
+ *        .where(id, isLessThan(100)));
  * </pre>
  * 
+ * <p>In this way, you could mimic the function of the old style "updateByExampleSelective" methods from
+ * MyBatis Generator.
+ * 
  * @author Jeff Butler
  */
 @FunctionalInterface
-public interface MyBatis3UpdateByExampleHelper extends
+public interface MyBatis3UpdateHelper extends
         Function<UpdateDSL<MyBatis3UpdateModelAdapter<Integer>>, Buildable<MyBatis3UpdateModelAdapter<Integer>>> {
 }

src/test/java/examples/simple/SimpleTableAnnotatedMapperNewStyle.java

@@ -42,14 +42,14 @@
 import org.mybatis.dynamic.sql.update.UpdateDSL;
 import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider;
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
-import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3CountByExampleHelper;
-import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3DeleteByExampleHelper;
-import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3SelectByExampleHelper;
-import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3UpdateByExampleHelper;
+import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3CountHelper;
+import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3DeleteHelper;
+import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3SelectHelper;
+import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3UpdateHelper;
 
 /**
  * 
- * Note: this is the canonical mapper with the new style ByExample methods
+ * Note: this is the canonical mapper with the new style methods
  * and represents the desired output for MyBatis Generator 
  *
  */
@@ -90,24 +90,23 @@ public interface SimpleTableAnnotatedMapperNewStyle {
     @SelectProvider(type=SqlProviderAdapter.class, method="select")
     long count(SelectStatementProvider selectStatement);
 
-    default long countByExample(MyBatis3CountByExampleHelper helper) {
+    default long count(MyBatis3CountHelper helper) {
         return helper.apply(SelectDSL.selectWithMapper(this::count, SqlBuilder.count())
                 .from(simpleTable))
                 .build()
                 .execute();
     }
 
-    default int deleteByExample(MyBatis3DeleteByExampleHelper helper) {
+    default int delete(MyBatis3DeleteHelper helper) {
         return helper.apply(DeleteDSL.deleteFromWithMapper(this::delete, simpleTable))
                 .build()
                 .execute();
     }
 
     default int deleteByPrimaryKey(Integer id_) {
-        return DeleteDSL.deleteFromWithMapper(this::delete, simpleTable)
-                .where(id,  isEqualTo(id_))
-                .build()
-                .execute();
+        return delete(h ->
+            h.where(id, isEqualTo(id_))
+        );
     }
 
     default int insert(SimpleTableRecord record) {
@@ -149,14 +148,14 @@ default int insertSelective(SimpleTableRecord record) {
                 .render(RenderingStrategy.MYBATIS3));
     }
 
-    default List<SimpleTableRecord> selectByExample(MyBatis3SelectByExampleHelper<SimpleTableRecord> helper) {
+    default List<SimpleTableRecord> select(MyBatis3SelectHelper<SimpleTableRecord> helper) {
         return helper.apply(SelectDSL.selectWithMapper(this::selectMany, id.as("A_ID"), firstName, lastName, birthDate, employed, occupation)
                 .from(simpleTable))
                 .build()
                 .execute();
     }
 
-    default List<SimpleTableRecord> selectDistinctByExample(MyBatis3SelectByExampleHelper<SimpleTableRecord> helper) {
+    default List<SimpleTableRecord> selectDistinct(MyBatis3SelectHelper<SimpleTableRecord> helper) {
         return helper.apply(SelectDSL.selectDistinctWithMapper(this::selectMany, id.as("A_ID"), firstName, lastName, birthDate, employed, occupation)
                 .from(simpleTable))
                 .build()
@@ -171,7 +170,7 @@ default SimpleTableRecord selectByPrimaryKey(Integer id_) {
             .execute();
     }
 
-    default int update(MyBatis3UpdateByExampleHelper helper) {
+    default int update(MyBatis3UpdateHelper helper) {
         return helper.apply(UpdateDSL.updateWithMapper(this::update, simpleTable))
                 .build()
                 .execute();
@@ -186,7 +185,8 @@ static UpdateDSL<MyBatis3UpdateModelAdapter<Integer>> setAll(SimpleTableRecord r
                 .set(occupation).equalTo(record::getOccupation);
     }
 
-    static UpdateDSL<MyBatis3UpdateModelAdapter<Integer>> setSelective(SimpleTableRecord record, UpdateDSL<MyBatis3UpdateModelAdapter<Integer>> dsl) {
+    static UpdateDSL<MyBatis3UpdateModelAdapter<Integer>> setSelective(SimpleTableRecord record,
+            UpdateDSL<MyBatis3UpdateModelAdapter<Integer>> dsl) {
         return dsl.set(id).equalToWhenPresent(record::getId)
                 .set(firstName).equalToWhenPresent(record::getFirstName)
                 .set(lastName).equalToWhenPresent(record::getLastName)