Merge pull request #119 from jeffgbutler/new-style-by-example

New Utility Functions for *ByExample Support

Author: jeffgbutler

CHANGELOG.md

@@ -4,12 +4,13 @@ This log will detail notable changes to MyBatis Dynamic SQL. Full details are av
 
 ## Release 1.1.3 - Unreleased
 
-GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=milestone%3A1.1.2+](https://github.com/mybatis/mybatis-dynamic-sql/issues?q=milestone%3A1.1.3+)
+GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=milestone%3A1.1.3+](https://github.com/mybatis/mybatis-dynamic-sql/issues?q=milestone%3A1.1.3+)
 
 ### Added
 
-- Added support for `count(distinct ...)` [#112](https://github.com/mybatis/mybatis-dynamic-sql/issues/112)
-- Added support for multiple row inserts [#116](https://github.com/mybatis/mybatis-dynamic-sql/issues/116)
+- Added support for `count(distinct ...)` ([#112](https://github.com/mybatis/mybatis-dynamic-sql/issues/112))
+- Added support for multiple row inserts ([#116](https://github.com/mybatis/mybatis-dynamic-sql/issues/116))
+- Added utility functions to support better *ByExample methods ([#118](https://github.com/mybatis/mybatis-dynamic-sql/issues/118))
 
 
 ## Release 1.1.2 - July 5, 2019
@@ -18,12 +19,12 @@ GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=miles
 
 ### Added
 
-- Changed the public SQLBuilder API to accept Collection instead of List for in conditions and batch record inserts. This should have no impact on existing code, but allow for some future flexibility [#88](https://github.com/mybatis/mybatis-dynamic-sql/pull/88)
-- Added the ability have have table catalog and/or schema calculated at query runtime. This is useful for situations where there are different database schemas for different environments, or in some sharding situations [#92](https://github.com/mybatis/mybatis-dynamic-sql/pull/92)
-- Add support for paging queries with "offset" and "fetch first" - this seems to be standard on most databases [#96](https://github.com/mybatis/mybatis-dynamic-sql/pull/96)
-- Added the ability to call a builder method on any intermediate object in a select statement and receive a fully rendered statement. This makes it easier to build very dynamic queries [#106](https://github.com/mybatis/mybatis-dynamic-sql/pull/106)
-- Add the ability to modify values on any condition before they are placed in the parameter map [#105](https://github.com/mybatis/mybatis-dynamic-sql/issues/105)
-- Add the ability to call `where()` with no parameters. This aids in constructing very dynamic queries [#107](https://github.com/mybatis/mybatis-dynamic-sql/issues/107)
+- Changed the public SQLBuilder API to accept Collection instead of List for in conditions and batch record inserts. This should have no impact on existing code, but allow for some future flexibility ([#88](https://github.com/mybatis/mybatis-dynamic-sql/pull/88))
+- Added the ability have have table catalog and/or schema calculated at query runtime. This is useful for situations where there are different database schemas for different environments, or in some sharding situations ([#92](https://github.com/mybatis/mybatis-dynamic-sql/pull/92))
+- Add support for paging queries with "offset" and "fetch first" - this seems to be standard on most databases ([#96](https://github.com/mybatis/mybatis-dynamic-sql/pull/96))
+- Added the ability to call a builder method on any intermediate object in a select statement and receive a fully rendered statement. This makes it easier to build very dynamic queries ([#106](https://github.com/mybatis/mybatis-dynamic-sql/pull/106))
+- Add the ability to modify values on any condition before they are placed in the parameter map ([#105](https://github.com/mybatis/mybatis-dynamic-sql/issues/105))
+- Add the ability to call `where()` with no parameters. This aids in constructing very dynamic queries ([#107](https://github.com/mybatis/mybatis-dynamic-sql/issues/107))
 
 
 ## Release 1.1.1 - April 7, 2019

src/main/java/org/mybatis/dynamic/sql/delete/DeleteDSL.java

@@ -23,9 +23,10 @@
 import org.mybatis.dynamic.sql.SqlTable;
 import org.mybatis.dynamic.sql.VisitableCondition;
 import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
+import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
 
-public class DeleteDSL<R> {
+public class DeleteDSL<R> implements Buildable<R> {
 
     private Function<DeleteModel, R> adapterFunction;
     private SqlTable table;
@@ -54,6 +55,7 @@ public <T> DeleteWhereBuilder where(BindableColumn<T> column, VisitableCondition
      * 
      * @return the model class
      */
+    @Override
     public R build() {
         DeleteModel deleteModel = DeleteModel.withTable(table).build();
         return adapterFunction.apply(deleteModel);
@@ -72,7 +74,7 @@ public static <T> DeleteDSL<MyBatis3DeleteModelAdapter<T>> deleteFromWithMapper(
         return deleteFrom(deleteModel -> MyBatis3DeleteModelAdapter.of(deleteModel, mapperMethod), table);
     }
 
-    public class DeleteWhereBuilder extends AbstractWhereDSL<DeleteWhereBuilder> {
+    public class DeleteWhereBuilder extends AbstractWhereDSL<DeleteWhereBuilder> implements Buildable<R> {
 
         private <T> DeleteWhereBuilder() {
             super();
@@ -87,6 +89,7 @@ private <T> DeleteWhereBuilder(BindableColumn<T> column, VisitableCondition<T> c
             super(column, condition, subCriteria);
         }
 
+        @Override
         public R build() {
             DeleteModel deleteModel = DeleteModel.withTable(table)
                     .withWhereModel(buildWhereModel())

src/main/java/org/mybatis/dynamic/sql/update/UpdateDSL.java

@@ -39,7 +39,7 @@
 import org.mybatis.dynamic.sql.util.ValueMapping;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
 
-public class UpdateDSL<R> {
+public class UpdateDSL<R> implements Buildable<R> {
 
     private Function<UpdateModel, R> adapterFunction;
     private List<UpdateMapping> columnMappings = new ArrayList<>();
@@ -73,6 +73,7 @@ public <T> UpdateWhereBuilder where(BindableColumn<T> column, VisitableCondition
      * 
      * @return the update model
      */
+    @Override
     public R build() {
         UpdateModel updateModel = UpdateModel.withTable(table)
                 .withColumnMappings(columnMappings)
@@ -147,7 +148,7 @@ public UpdateDSL<R> equalToWhenPresent(Supplier<T> valueSupplier) {
         }
     }
 
-    public class UpdateWhereBuilder extends AbstractWhereDSL<UpdateWhereBuilder> {
+    public class UpdateWhereBuilder extends AbstractWhereDSL<UpdateWhereBuilder> implements Buildable<R> {
 
         public <T> UpdateWhereBuilder() {
             super();
@@ -162,6 +163,7 @@ public <T> UpdateWhereBuilder(BindableColumn<T> column, VisitableCondition<T> co
             super(column, condition, subCriteria);
         }
 
+        @Override
         public R build() {
             UpdateModel updateModel = UpdateModel.withTable(table)
                     .withColumnMappings(columnMappings)

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

@@ -0,0 +1,61 @@
+/**
+ *    Copyright 2016-2019 the original author or authors.
+ *
+ *    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 org.mybatis.dynamic.sql.util.mybatis3;
+
+import java.util.function.Function;
+
+import org.mybatis.dynamic.sql.select.MyBatis3SelectModelAdapter;
+import org.mybatis.dynamic.sql.select.QueryExpressionDSL;
+import org.mybatis.dynamic.sql.util.Buildable;
+
+/**
+ * Represents a function that can be used to create a "CountByExample" 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.
+ * 
+ * <p>For example, you can create mapper interface methods like this:
+ * 
+ * <pre>
+ * &#64;SelectProvider(type=SqlProviderAdapter.class, method="select")
+ * long count(SelectStatementProvider selectStatement);
+ *   
+ * default long countByExample(MyBatis3CountByExampleHelper helper) {
+ *     return helper.apply(SelectDSL.selectWithMapper(this::count, SqlBuilder.count())
+ *             .from(simpleTable))
+ *             .build()
+ *             .execute();
+ * }
+ * </pre>
+ * 
+ * <p>And then call the simplified default method like this:
+ * 
+ * <pre>
+ * long rows = mapper.countByExample(q -&gt;
+ *         q.where(occupation, isNull()));
+ * </pre>
+ * 
+ * <p>You can also do a "count all" with the following code:
+ * 
+ * <pre>
+ * long rows = mapper.countByExample(q -&gt; q);
+ * </pre>
+ *  
+ * @author Jeff Butler
+ */
+@FunctionalInterface
+public interface MyBatis3CountByExampleHelper extends
+        Function<QueryExpressionDSL<MyBatis3SelectModelAdapter<Long>>, Buildable<MyBatis3SelectModelAdapter<Long>>> {
+}

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

@@ -0,0 +1,60 @@
+/**
+ *    Copyright 2016-2019 the original author or authors.
+ *
+ *    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 org.mybatis.dynamic.sql.util.mybatis3;
+
+import java.util.function.Function;
+
+import org.mybatis.dynamic.sql.delete.DeleteDSL;
+import org.mybatis.dynamic.sql.delete.MyBatis3DeleteModelAdapter;
+import org.mybatis.dynamic.sql.util.Buildable;
+
+/**
+ * Represents a function that can be used to create a "DeleteByExample" 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.
+ * 
+ * <p>For example, you can create mapper interface methods like this:
+ * 
+ * <pre>
+ * &#64;DeleteProvider(type=SqlProviderAdapter.class, method="delete")
+ * int delete(DeleteStatementProvider deleteStatement);
+ *   
+ * default int deleteByExample(MyBatis3DeleteByExampleHelper helper) {
+ *     return helper.apply(DeleteDSL.deleteFromWithMapper(this::delete, simpleTable))
+ *           .build()
+ *           .execute();
+ * }
+ * </pre>
+ * 
+ * <p>And then call the simplified default method like this:
+ * 
+ * <pre>
+ * int rows = mapper.deleteByExample(q -&gt;
+ *           q.where(occupation, isNull()));
+ * </pre>
+ *  
+ * <p>You can also do a "delete all" with the following code:
+ * 
+ * <pre>
+ * int rows = mapper.deleteByExample(q -&gt; q);
+ * </pre>
+ * 
+ * @author Jeff Butler
+ */
+@FunctionalInterface
+public interface MyBatis3DeleteByExampleHelper extends
+        Function<DeleteDSL<MyBatis3DeleteModelAdapter<Integer>>, Buildable<MyBatis3DeleteModelAdapter<Integer>>> {
+}

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

@@ -0,0 +1,72 @@
+/**
+ *    Copyright 2016-2019 the original author or authors.
+ *
+ *    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 org.mybatis.dynamic.sql.util.mybatis3;
+
+import java.util.List;
+import java.util.function.Function;
+
+import org.mybatis.dynamic.sql.select.MyBatis3SelectModelAdapter;
+import org.mybatis.dynamic.sql.select.QueryExpressionDSL;
+import org.mybatis.dynamic.sql.util.Buildable;
+
+/**
+ * Represents a function that can be used to create a "SelectByExample" 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.
+ * 
+ * <p>For example, you can create mapper interface methods like this:
+ * 
+ * <pre>
+ * &#64;SelectProvider(type=SqlProviderAdapter.class, method="select")
+ * &#64;Results(id="SimpleTableResult", value= {
+ *         &#64;Result(column="id", property="id", jdbcType=JdbcType.INTEGER, id=true),
+ *         &#64;Result(column="first_name", property="firstName", jdbcType=JdbcType.VARCHAR),
+ *         &#64;Result(column="last_name", property="lastName", jdbcType=JdbcType.VARCHAR),
+ *         &#64;Result(column="birth_date", property="birthDate", jdbcType=JdbcType.DATE),
+ *         &#64;Result(column="employed", property="employed", jdbcType=JdbcType.VARCHAR),
+ *         &#64;Result(column="occupation", property="occupation", jdbcType=JdbcType.VARCHAR)
+ * })
+ * List&lt;SimpleRecord&gt; selectMany(SelectStatementProvider selectStatement);
+ *
+ * default List&lt;SimpleRecord&gt; selectByExample(MyBatis3SelectByExampleHelper&lt;SimpleRecord&gt; helper) {
+ *     return helper.apply(SelectDSL.selectWithMapper(this::selectMany, simpleTable.allColumns())
+ *             .from(simpleTable))
+ *             .build()
+ *             .execute();
+ * }
+ * </pre>
+ * 
+ * <p>And then call the simplified default method like this:
+ * 
+ * <pre>
+ * List&lt;SimpleRecord&gt; rows = mapper.selectByExample(q -&gt;
+ *     q.where(id, isEqualTo(1))
+ *     .or(occupation, isNull()));
+ * </pre>
+ *  
+ * <p>You can also do a "select all" with the following code:
+ * 
+ * <pre>
+ * List&lt;SimpleRecord&gt; rows = mapper.selectByExample(q -&gt; q);
+ * </pre>
+ * 
+ * @author Jeff Butler
+ */
+@FunctionalInterface
+public interface MyBatis3SelectByExampleHelper<T> extends
+        Function<QueryExpressionDSL<MyBatis3SelectModelAdapter<List<T>>>,
+        Buildable<MyBatis3SelectModelAdapter<List<T>>>> {
+}

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

@@ -0,0 +1,67 @@
+/**
+ *    Copyright 2016-2019 the original author or authors.
+ *
+ *    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 org.mybatis.dynamic.sql.util.mybatis3;
+
+import java.util.function.Function;
+
+import org.mybatis.dynamic.sql.update.MyBatis3UpdateModelAdapter;
+import org.mybatis.dynamic.sql.update.UpdateDSL;
+import org.mybatis.dynamic.sql.util.Buildable;
+
+/**
+ * Represents a function that can be used to create an "UpdateByExample" 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.
+ * 
+ * <p>For example, you can create mapper interface methods like this:
+ * 
+ * <pre>
+ * &#64;UpdateProvider(type=SqlProviderAdapter.class, method="update")
+ * int update(UpdateStatementProvider updateStatement);
+ *   
+ * default int updateByExampleSelective(SimpleTableRecord record, MyBatis3UpdateByExampleHelper helper) {
+ *     return helper.apply(UpdateDSL.updateWithMapper(this::update, simpleTable)
+ *             .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))
+ *             .build()
+ *             .execute();
+ * }
+ * </pre>
+ * 
+ * <p>And then call the simplified default method like this:
+ * 
+ * <pre>
+ * int rows = mapper.updateByExampleSelective(record, q -&gt;
+ *                q.where(id, isEqualTo(100))
+ *                .and(firstName, isEqualTo("Joe")));
+ * </pre>
+ *  
+ * <p>You can also do an "update all" with the following code:
+ * 
+ * <pre>
+ * int rows = mapper.updateByExampleSelective(record, q -&gt; q);
+ * </pre>
+ * 
+ * @author Jeff Butler
+ */
+@FunctionalInterface
+public interface MyBatis3UpdateByExampleHelper extends
+        Function<UpdateDSL<MyBatis3UpdateModelAdapter<Integer>>, Buildable<MyBatis3UpdateModelAdapter<Integer>>> {
+}