Add Support for Reusing Where Clauses

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 This log will detail notable changes to MyBatis Dynamic SQL. Full details are available on the GitHub milestone pages.
 
+## Release 1.1.4 - Unreleased
+
+GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=milestone%3A1.1.4+](https://github.com/mybatis/mybatis-dynamic-sql/issues?q=milestone%3A1.1.4+)
+
+### Added
+
+- Added support for reusing WHERE clauses among count, delete, select, and update statements ([#152](https://github.com/mybatis/mybatis-dynamic-sql/pull/152))
+
+
+### Bugs Fixed
+
+- Fixed issue where limit and offset in sub-queries could cause a parameter name collision ([#142](https://github.com/mybatis/mybatis-dynamic-sql/pull/142))
+
 ## Release 1.1.3 - September 16, 2019
 
 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+)

src/main/java/org/mybatis/dynamic/sql/SqlBuilder.java

@@ -162,12 +162,12 @@ static WhereDSL where() {
     }
 
     static <T> WhereDSL where(BindableColumn<T> column, VisitableCondition<T> condition) {
-        return WhereDSL.where(column, condition);
+        return WhereDSL.where().where(column, condition);
     }
 
     static <T> WhereDSL where(BindableColumn<T> column, VisitableCondition<T> condition,
             SqlCriterion<?>... subCriteria) {
-        return WhereDSL.where(column, condition, subCriteria);
+        return WhereDSL.where().where(column, condition, subCriteria);
     }
 
     // where condition connectors

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

@@ -27,6 +27,8 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3Utils;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
+import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class DeleteDSL<R> implements Buildable<R> {
 
@@ -45,10 +47,15 @@ public DeleteWhereBuilder where() {
 
     public <T> DeleteWhereBuilder where(BindableColumn<T> column, VisitableCondition<T> condition,
             SqlCriterion<?>...subCriteria) {
-        whereBuilder.and(column, condition, subCriteria);
+        whereBuilder.where(column, condition, subCriteria);
         return whereBuilder;
     }
 
+    @SuppressWarnings("unchecked")
+    public DeleteWhereBuilder applyWhere(WhereApplier whereApplier) {
+        return (DeleteWhereBuilder) whereApplier.apply(whereBuilder);
+    }
+
     /**
      * WARNING! Calling this method could result in an delete statement that deletes
      * all rows in a table.
@@ -102,5 +109,10 @@ public R build() {
         protected DeleteWhereBuilder getThis() {
             return this;
         }
+
+        @Override
+        protected WhereModel buildWhereModel() {
+            return super.internalBuild();
+        }
     }
 }

src/main/java/org/mybatis/dynamic/sql/select/CountDSL.java

@@ -25,6 +25,8 @@
 import org.mybatis.dynamic.sql.VisitableCondition;
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
+import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 /**
  * DSL for building count queries. Count queries are specializations of select queries. They have joins and where
@@ -51,10 +53,15 @@ public CountWhereBuilder where() {
 
     public <T> CountWhereBuilder where(BindableColumn<T> column, VisitableCondition<T> condition,
             SqlCriterion<?>...subCriteria) {
-        whereBuilder.and(column, condition, subCriteria);
+        whereBuilder.where(column, condition, subCriteria);
         return whereBuilder;
     }
 
+    @SuppressWarnings("unchecked")
+    public CountWhereBuilder applyWhere(WhereApplier whereApplier) {
+        return (CountWhereBuilder) whereApplier.apply(whereBuilder);
+    }
+
     @Override
     public R build() {
         return adapterFunction.apply(buildModel());
@@ -100,5 +107,10 @@ public R build() {
         protected CountWhereBuilder getThis() {
             return this;
         }
+
+        @Override
+        protected WhereModel buildWhereModel() {
+            return super.internalBuild();
+        }
     }
 }

src/main/java/org/mybatis/dynamic/sql/select/QueryExpressionDSL.java

@@ -33,6 +33,8 @@
 import org.mybatis.dynamic.sql.select.join.JoinType;
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
+import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class QueryExpressionDSL<R> extends AbstractQueryExpressionDSL<QueryExpressionDSL<R>, R>
         implements Buildable<R> {
@@ -63,10 +65,15 @@ public QueryExpressionWhereBuilder where() {
 
     public <T> QueryExpressionWhereBuilder where(BindableColumn<T> column, VisitableCondition<T> condition,
             SqlCriterion<?>...subCriteria) {
-        whereBuilder.and(column, condition, subCriteria);
+        whereBuilder.where(column, condition, subCriteria);
         return whereBuilder;
     }
 
+    @SuppressWarnings("unchecked")
+    public QueryExpressionWhereBuilder applyWhere(WhereApplier whereApplier) {
+        return (QueryExpressionWhereBuilder) whereApplier.apply(whereBuilder);
+    }
+
     @Override
     public R build() {
         return selectDSL.build();
@@ -253,6 +260,11 @@ public R build() {
         protected QueryExpressionWhereBuilder getThis() {
             return this;
         }
+
+        @Override
+        protected WhereModel buildWhereModel() {
+            return super.internalBuild();
+        }
     }
 
     public class JoinSpecificationStarter {
@@ -322,6 +334,10 @@ public <T> QueryExpressionWhereBuilder where(BindableColumn<T> column, Visitable
             return QueryExpressionDSL.this.where(column, condition, subCriteria);
         }
 
+        public QueryExpressionWhereBuilder applyWhere(WhereApplier whereApplier) {
+            return QueryExpressionDSL.this.applyWhere(whereApplier);
+        }
+
         public JoinSpecificationFinisher and(BasicColumn joinColumn, JoinCondition joinCondition) {
             JoinCriterion joinCriterion = new JoinCriterion.Builder()
                     .withConnector("and") //$NON-NLS-1$

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

@@ -40,6 +40,8 @@
 import org.mybatis.dynamic.sql.util.ValueMapping;
 import org.mybatis.dynamic.sql.util.mybatis3.MyBatis3Utils;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
+import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class UpdateDSL<R> implements Buildable<R> {
 
@@ -63,10 +65,15 @@ public UpdateWhereBuilder where() {
 
     public <T> UpdateWhereBuilder where(BindableColumn<T> column, VisitableCondition<T> condition,
             SqlCriterion<?>...subCriteria) {
-        whereBuilder.and(column, condition, subCriteria);
+        whereBuilder.where(column, condition, subCriteria);
         return whereBuilder;
     }
 
+    @SuppressWarnings("unchecked")
+    public UpdateWhereBuilder applyWhere(WhereApplier whereApplier) {
+        return (UpdateWhereBuilder) whereApplier.apply(whereBuilder);
+    }
+
     /**
      * WARNING! Calling this method could result in an update statement that updates
      * all rows in a table.
@@ -175,5 +182,10 @@ public R build() {
         protected UpdateWhereBuilder getThis() {
             return this;
         }
+
+        @Override
+        protected WhereModel buildWhereModel() {
+            return super.internalBuild();
+        }
     }
 }

src/main/java/org/mybatis/dynamic/sql/where/AbstractWhereDSL.java

@@ -30,20 +30,19 @@ protected <S> AbstractWhereDSL() {
         super();
     }
 
-    protected <S> AbstractWhereDSL(BindableColumn<S> column, VisitableCondition<S> condition) {
-        SqlCriterion<S> criterion = SqlCriterion.withColumn(column)
-                .withCondition(condition)
-                .build();
-        criteria.add(criterion);
+    public <S> T where(BindableColumn<S> column, VisitableCondition<S> condition) {
+        addCriterion(column, condition);
+        return getThis();
     }
 
-    protected <S> AbstractWhereDSL(BindableColumn<S> column, VisitableCondition<S> condition,
-            SqlCriterion<?>...subCriteria) {
-        SqlCriterion<S> criterion = SqlCriterion.withColumn(column)
-                .withCondition(condition)
-                .withSubCriteria(Arrays.asList(subCriteria))
-                .build();
-        criteria.add(criterion);
+    public <S> T where(BindableColumn<S> column, VisitableCondition<S> condition, SqlCriterion<?>...subCriteria) {
+        addCriterion(column, condition, Arrays.asList(subCriteria));
+        return getThis();
+    }
+
+    public <S> T where(BindableColumn<S> column, VisitableCondition<S> condition, List<SqlCriterion<?>> subCriteria) {
+        addCriterion(column, condition, subCriteria);
+        return getThis();
     }
 
     public <S> T and(BindableColumn<S> column, VisitableCondition<S> condition) {
@@ -76,6 +75,13 @@ public <S> T or(BindableColumn<S> column, VisitableCondition<S> condition, List<
         return getThis();
     }
 
+    private <S> void addCriterion(BindableColumn<S> column, VisitableCondition<S> condition) {
+        SqlCriterion<S> criterion = SqlCriterion.withColumn(column)
+                .withCondition(condition)
+                .build();
+        criteria.add(criterion);
+    }
+
     private <S> void addCriterion(String connector, BindableColumn<S> column, VisitableCondition<S> condition) {
         SqlCriterion<S> criterion = SqlCriterion.withColumn(column)
                 .withConnector(connector)
@@ -84,6 +90,15 @@ private <S> void addCriterion(String connector, BindableColumn<S> column, Visita
         criteria.add(criterion);
     }
 
+    private <S> void addCriterion(BindableColumn<S> column, VisitableCondition<S> condition,
+            List<SqlCriterion<?>> subCriteria) {
+        SqlCriterion<S> criterion = SqlCriterion.withColumn(column)
+                .withCondition(condition)
+                .withSubCriteria(subCriteria)
+                .build();
+        criteria.add(criterion);
+    }
+
     private <S> void addCriterion(String connector, BindableColumn<S> column, VisitableCondition<S> condition,
             List<SqlCriterion<?>> subCriteria) {
         SqlCriterion<S> criterion = SqlCriterion.withColumn(column)
@@ -94,9 +109,11 @@ private <S> void addCriterion(String connector, BindableColumn<S> column, Visita
         criteria.add(criterion);
     }
 
-    public WhereModel buildWhereModel() {
+    protected WhereModel internalBuild() {
         return WhereModel.of(criteria);
     }
 
+    protected abstract WhereModel buildWhereModel();
+
     protected abstract T getThis();
 }

src/main/java/org/mybatis/dynamic/sql/where/WhereApplier.java

@@ -0,0 +1,21 @@
+/**
+ *    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.where;
+
+import java.util.function.UnaryOperator;
+
+@FunctionalInterface
+public interface WhereApplier extends UnaryOperator<AbstractWhereDSL<?>> {}

src/main/java/org/mybatis/dynamic/sql/where/WhereDSL.java

@@ -15,24 +15,12 @@
  */
 package org.mybatis.dynamic.sql.where;
 
-import org.mybatis.dynamic.sql.BindableColumn;
-import org.mybatis.dynamic.sql.SqlCriterion;
-import org.mybatis.dynamic.sql.VisitableCondition;
-
 public class WhereDSL extends AbstractWhereDSL<WhereDSL> {
 
     private WhereDSL() {
         super();
     }
 
-    private <T> WhereDSL(BindableColumn<T> column, VisitableCondition<T> condition) {
-        super(column, condition);
-    }
-
-    private <T> WhereDSL(BindableColumn<T> column, VisitableCondition<T> condition, SqlCriterion<?>... subCriteria) {
-        super(column, condition, subCriteria);
-    }
-
     @Override
     protected WhereDSL getThis() {
         return this;
@@ -42,16 +30,12 @@ public static WhereDSL where() {
         return new WhereDSL();
     }
 
-    public static <T> WhereDSL where(BindableColumn<T> column, VisitableCondition<T> condition) {
-        return new WhereDSL(column, condition);
-    }
-
-    public static <T> WhereDSL where(BindableColumn<T> column, VisitableCondition<T> condition,
-            SqlCriterion<?>... subCriteria) {
-        return new WhereDSL(column, condition, subCriteria);
+    @Override
+    protected WhereModel buildWhereModel() {
+        return super.internalBuild();
     }
 
     public WhereModel build() {
-        return super.buildWhereModel();
+        return buildWhereModel();
     }
 }

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/AbstractWhereDSLExtensions.kt

@@ -19,6 +19,14 @@ import org.mybatis.dynamic.sql.BindableColumn
 import org.mybatis.dynamic.sql.VisitableCondition
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL
 
+typealias WhereApplier = AbstractWhereDSL<*>.() -> AbstractWhereDSL<*>
+
+fun <T, M : AbstractWhereDSL<M>> AbstractWhereDSL<M>.where(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver): M {
+    val collector = CriteriaCollector()
+    collect(collector)
+    return where(column, condition, collector.criteria)
+}
+
 fun <T, M : AbstractWhereDSL<M>> AbstractWhereDSL<M>.and(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver): M {
     val collector = CriteriaCollector()
     collect(collector)

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/CountDSLExtensions.kt

@@ -25,7 +25,7 @@ typealias CountCompleter = CountDSL<SelectModel>.() -> Buildable<SelectModel>
 
 fun <T> CountDSL<SelectModel>.where(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver) =
     apply {
-        where().and(column, condition, collect)
+        where().where(column, condition, collect)
     }
 
 fun <T> CountDSL<SelectModel>.and(column: BindableColumn<T>, condition: VisitableCondition<T>) =

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/DeleteDSLExtensions.kt

@@ -25,7 +25,7 @@ typealias DeleteCompleter = DeleteDSL<DeleteModel>.() -> Buildable<DeleteModel>
 
 fun <T> DeleteDSL<DeleteModel>.where(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver) =
     apply {
-        where().and(column, condition, collect)
+        where().where(column, condition, collect)
     }
 
 fun <T> DeleteDSL<DeleteModel>.and(column: BindableColumn<T>, condition: VisitableCondition<T>) =

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/QueryExpressionDSLExtensions.kt

@@ -25,7 +25,7 @@ typealias SelectCompleter = QueryExpressionDSL<SelectModel>.() -> Buildable<Sele
 
 fun <T> QueryExpressionDSL<SelectModel>.where(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver) =
     apply {
-        where().and(column, condition, collect)
+        where().where(column, condition, collect)
     }
 
 fun <T> QueryExpressionDSL<SelectModel>.and(column: BindableColumn<T>, condition: VisitableCondition<T>) =

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/UpdateDSLExtensions.kt

@@ -31,7 +31,7 @@ typealias UpdateCompleter = UpdateDSL<UpdateModel>.() -> Buildable<UpdateModel>
 
 fun <T> UpdateDSL<UpdateModel>.where(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver) =
     apply {
-        where().and(column, condition, collect)
+        where().where(column, condition, collect)
     }
 
 fun <T> UpdateDSL<UpdateModel>.and(column: BindableColumn<T>, condition: VisitableCondition<T>) =