Use a builder for boolean expression model

jeffgbutler · jeffgbutler · commit 5c9454f92618 · 2024-03-19T09:15:01.000-04:00
diff --git a/src/main/java/org/mybatis/dynamic/sql/common/AbstractBooleanExpressionModel.java b/src/main/java/org/mybatis/dynamic/sql/common/AbstractBooleanExpressionModel.java
@@ -25,11 +25,11 @@
 
 public abstract class AbstractBooleanExpressionModel {
     private final SqlCriterion initialCriterion;
-    private final List<AndOrCriteriaGroup> subCriteria = new ArrayList<>();
+    private final List<AndOrCriteriaGroup> subCriteria ;
 
-    protected AbstractBooleanExpressionModel(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria) {
-        this.initialCriterion = initialCriterion;
-        this.subCriteria.addAll(subCriteria);
+    protected AbstractBooleanExpressionModel(AbstractBuilder<?> builder) {
+        initialCriterion = builder.initialCriterion;
+        subCriteria = builder.subCriteria;
     }
 
     public Optional<SqlCriterion> initialCriterion() {
@@ -39,4 +39,21 @@ public Optional<SqlCriterion> initialCriterion() {
     public List<AndOrCriteriaGroup> subCriteria() {
         return Collections.unmodifiableList(subCriteria);
     }
+
+    public abstract static class AbstractBuilder<T extends AbstractBuilder<T>> {
+        private SqlCriterion initialCriterion;
+        private final List<AndOrCriteriaGroup> subCriteria = new ArrayList<>();
+
+        public T withInitialCriterion(SqlCriterion initialCriterion) {
+            this.initialCriterion = initialCriterion;
+            return getThis();
+        }
+
+        public T withSubCriteria(List<AndOrCriteriaGroup> subCriteria) {
+            this.subCriteria.addAll(subCriteria);
+            return getThis();
+        }
+
+        protected abstract T getThis();
+    }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/AbstractHavingFinisher.java b/src/main/java/org/mybatis/dynamic/sql/select/AbstractHavingFinisher.java
@@ -33,6 +33,9 @@ void initialize(SqlCriterion sqlCriterion, List<AndOrCriteriaGroup> subCriteria)
     }
 
     protected HavingModel buildModel() {
-        return new HavingModel(getInitialCriterion(), subCriteria);
+        return new HavingModel.Builder()
+                .withInitialCriterion(getInitialCriterion())
+                .withSubCriteria(subCriteria)
+                .build();
     }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/HavingModel.java b/src/main/java/org/mybatis/dynamic/sql/select/HavingModel.java
@@ -15,14 +15,21 @@
  */
 package org.mybatis.dynamic.sql.select;
 
-import java.util.List;
-
-import org.mybatis.dynamic.sql.AndOrCriteriaGroup;
-import org.mybatis.dynamic.sql.SqlCriterion;
 import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionModel;
 
 public class HavingModel extends AbstractBooleanExpressionModel {
-    public HavingModel(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria) {
-        super(initialCriterion, subCriteria);
+    private HavingModel(Builder builder) {
+        super(builder);
+    }
+
+    public static class Builder extends AbstractBuilder<Builder> {
+        public HavingModel build() {
+            return new HavingModel(this);
+        }
+
+        @Override
+        protected Builder getThis() {
+            return this;
+        }
     }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/caseexpression/SearchedCaseDSL.java b/src/main/java/org/mybatis/dynamic/sql/select/caseexpression/SearchedCaseDSL.java
@@ -29,7 +29,7 @@
 import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionDSL;
 
 public class SearchedCaseDSL implements ElseDSL<SearchedCaseDSL.SearchedCaseEnder> {
-    private final List<SearchedCaseModel.SearchedWhenCondition> whenConditions = new ArrayList<>();
+    private final List<SearchedCaseWhenCondition> whenConditions = new ArrayList<>();
     private BasicColumn elseValue;
 
     public <T> WhenDSL when(BindableColumn<T> column, VisitableCondition<T> condition,
@@ -85,8 +85,11 @@ private WhenDSL(SqlCriterion sqlCriterion) {
 
         @Override
         public SearchedCaseDSL then(BasicColumn column) {
-            whenConditions.add(new SearchedCaseModel.SearchedWhenCondition(getInitialCriterion(), subCriteria,
-                    column));
+            whenConditions.add(new SearchedCaseWhenCondition.Builder()
+                    .withInitialCriterion(getInitialCriterion())
+                    .withSubCriteria(subCriteria)
+                    .withThenValue(column)
+                    .build());
             return SearchedCaseDSL.this;
         }
 
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/caseexpression/SearchedCaseModel.java b/src/main/java/org/mybatis/dynamic/sql/select/caseexpression/SearchedCaseModel.java
@@ -17,21 +17,17 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Objects;
 import java.util.Optional;
 import java.util.stream.Stream;
 
-import org.mybatis.dynamic.sql.AndOrCriteriaGroup;
 import org.mybatis.dynamic.sql.BasicColumn;
-import org.mybatis.dynamic.sql.SqlCriterion;
-import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionModel;
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.select.render.SearchedCaseRenderer;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.Validator;
 
 public class SearchedCaseModel implements BasicColumn {
-    private final List<SearchedWhenCondition> whenConditions;
+    private final List<SearchedCaseWhenCondition> whenConditions;
     private final BasicColumn elseValue;
     private final String alias;
 
@@ -42,7 +38,7 @@ private SearchedCaseModel(Builder builder) {
         Validator.assertNotEmpty(whenConditions, "ERROR.40"); //$NON-NLS-1$
     }
 
-    public Stream<SearchedWhenCondition> whenConditions() {
+    public Stream<SearchedCaseWhenCondition> whenConditions() {
         return whenConditions.stream();
     }
 
@@ -68,27 +64,12 @@ public FragmentAndParameters render(RenderingContext renderingContext) {
         return new SearchedCaseRenderer(this, renderingContext).render();
     }
 
-    public static class SearchedWhenCondition extends AbstractBooleanExpressionModel {
-
-        private final BasicColumn thenValue;
-
-        public BasicColumn thenValue() {
-            return thenValue;
-        }
-
-        public SearchedWhenCondition(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria,
-                                     BasicColumn thenValue) {
-            super(initialCriterion, subCriteria);
-            this.thenValue = Objects.requireNonNull(thenValue);
-        }
-    }
-
     public static class Builder {
-        private final List<SearchedWhenCondition> whenConditions = new ArrayList<>();
+        private final List<SearchedCaseWhenCondition> whenConditions = new ArrayList<>();
         private BasicColumn elseValue;
         private String alias;
 
-        public Builder withWhenConditions(List<SearchedWhenCondition> whenConditions) {
+        public Builder withWhenConditions(List<SearchedCaseWhenCondition> whenConditions) {
             this.whenConditions.addAll(whenConditions);
             return this;
         }
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/caseexpression/SearchedCaseWhenCondition.java b/src/main/java/org/mybatis/dynamic/sql/select/caseexpression/SearchedCaseWhenCondition.java
@@ -0,0 +1,52 @@
+/*
+ *    Copyright 2016-2024 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
+ *
+ *       https://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.select.caseexpression;
+
+import java.util.Objects;
+
+import org.mybatis.dynamic.sql.BasicColumn;
+import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionModel;
+
+public class SearchedCaseWhenCondition extends AbstractBooleanExpressionModel {
+    private final BasicColumn thenValue;
+
+    public BasicColumn thenValue() {
+        return thenValue;
+    }
+
+    private SearchedCaseWhenCondition(Builder builder) {
+        super(builder);
+        thenValue = Objects.requireNonNull(builder.thenValue);
+    }
+
+    public static class Builder extends AbstractBuilder<Builder> {
+        private BasicColumn thenValue;
+
+        public Builder withThenValue(BasicColumn thenValue) {
+            this.thenValue = thenValue;
+            return this;
+        }
+
+        public SearchedCaseWhenCondition build() {
+            return new SearchedCaseWhenCondition(this);
+        }
+
+        @Override
+        protected Builder getThis() {
+            return this;
+        }
+    }
+}
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/render/SearchedCaseRenderer.java b/src/main/java/org/mybatis/dynamic/sql/select/render/SearchedCaseRenderer.java
@@ -24,6 +24,7 @@
 import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.select.caseexpression.SearchedCaseModel;
+import org.mybatis.dynamic.sql.select.caseexpression.SearchedCaseWhenCondition;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
 import org.mybatis.dynamic.sql.util.Messages;
@@ -56,12 +57,12 @@ private FragmentAndParameters renderWhenConditions() {
                 .toFragmentAndParameters(Collectors.joining(" ")); //$NON-NLS-1$
     }
 
-    private FragmentAndParameters renderWhenCondition(SearchedCaseModel.SearchedWhenCondition whenCondition) {
+    private FragmentAndParameters renderWhenCondition(SearchedCaseWhenCondition whenCondition) {
         return Stream.of(renderWhen(whenCondition), renderThen(whenCondition)).collect(FragmentCollector.collect())
                 .toFragmentAndParameters(Collectors.joining(" ")); //$NON-NLS-1$
     }
 
-    private FragmentAndParameters renderWhen(SearchedCaseModel.SearchedWhenCondition whenCondition) {
+    private FragmentAndParameters renderWhen(SearchedCaseWhenCondition whenCondition) {
         SearchedCaseWhenConditionRenderer renderer = new SearchedCaseWhenConditionRenderer.Builder(whenCondition)
                 .withRenderingContext(renderingContext)
                 .build();
@@ -70,7 +71,7 @@ private FragmentAndParameters renderWhen(SearchedCaseModel.SearchedWhenCondition
                 .orElseThrow(() -> new InvalidSqlException(Messages.getString("ERROR.39"))); //$NON-NLS-1$
     }
 
-    private FragmentAndParameters renderThen(SearchedCaseModel.SearchedWhenCondition whenCondition) {
+    private FragmentAndParameters renderThen(SearchedCaseWhenCondition whenCondition) {
         return whenCondition.thenValue().render(renderingContext).mapFragment(f -> "then " + f);
     }
 
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/render/SearchedCaseWhenConditionRenderer.java b/src/main/java/org/mybatis/dynamic/sql/select/render/SearchedCaseWhenConditionRenderer.java
@@ -16,17 +16,17 @@
 package org.mybatis.dynamic.sql.select.render;
 
 import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionRenderer;
-import org.mybatis.dynamic.sql.select.caseexpression.SearchedCaseModel.SearchedWhenCondition;
+import org.mybatis.dynamic.sql.select.caseexpression.SearchedCaseWhenCondition;
 
-public class SearchedCaseWhenConditionRenderer extends AbstractBooleanExpressionRenderer<SearchedWhenCondition> {
+public class SearchedCaseWhenConditionRenderer extends AbstractBooleanExpressionRenderer<SearchedCaseWhenCondition> {
     protected SearchedCaseWhenConditionRenderer(Builder builder) {
         super("when", builder);
     }
 
     public static class Builder
-            extends AbstractBooleanExpressionRenderer.AbstractBuilder<SearchedWhenCondition, Builder> {
+            extends AbstractBooleanExpressionRenderer.AbstractBuilder<SearchedCaseWhenCondition, Builder> {
 
-        protected Builder(SearchedWhenCondition model) {
+        protected Builder(SearchedCaseWhenCondition model) {
             super(model);
         }
 
diff --git a/src/main/java/org/mybatis/dynamic/sql/where/AbstractWhereFinisher.java b/src/main/java/org/mybatis/dynamic/sql/where/AbstractWhereFinisher.java
@@ -49,6 +49,10 @@ public T configureStatement(Consumer<StatementConfiguration> consumer) {
     }
 
     protected WhereModel buildModel() {
-        return new WhereModel(getInitialCriterion(), subCriteria, statementConfiguration);
+        return new WhereModel.Builder()
+                .withInitialCriterion(getInitialCriterion())
+                .withSubCriteria(subCriteria)
+                .withStatementConfiguration(statementConfiguration)
+                .build();
     }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/where/WhereModel.java b/src/main/java/org/mybatis/dynamic/sql/where/WhereModel.java
@@ -15,12 +15,9 @@
  */
 package org.mybatis.dynamic.sql.where;
 
-import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 
-import org.mybatis.dynamic.sql.AndOrCriteriaGroup;
-import org.mybatis.dynamic.sql.SqlCriterion;
 import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionModel;
 import org.mybatis.dynamic.sql.configuration.StatementConfiguration;
 import org.mybatis.dynamic.sql.render.RenderingContext;
@@ -33,10 +30,9 @@
 public class WhereModel extends AbstractBooleanExpressionModel {
     private final StatementConfiguration statementConfiguration;
 
-    public WhereModel(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria,
-            StatementConfiguration statementConfiguration) {
-        super(initialCriterion, subCriteria);
-        this.statementConfiguration = Objects.requireNonNull(statementConfiguration);
+    private WhereModel(Builder builder) {
+        super(builder);
+        statementConfiguration = Objects.requireNonNull(builder.statementConfiguration);
     }
 
     public boolean isNonRenderingClauseAllowed() {
@@ -100,4 +96,22 @@ private WhereClauseProvider toWhereClauseProvider(FragmentAndParameters fragment
                 .withParameters(fragmentAndParameters.parameters())
                 .build();
     }
+
+    public static class Builder extends AbstractBuilder<Builder> {
+        private StatementConfiguration statementConfiguration;
+
+        public Builder withStatementConfiguration(StatementConfiguration statementConfiguration) {
+            this.statementConfiguration = statementConfiguration;
+            return this;
+        }
+
+        public WhereModel build() {
+            return new WhereModel(this);
+        }
+
+        @Override
+        protected Builder getThis() {
+            return this;
+        }
+    }
 }
diff --git a/src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/elements/CaseDSLs.kt b/src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/elements/CaseDSLs.kt
@@ -19,7 +19,7 @@ import org.mybatis.dynamic.sql.BasicColumn
 import org.mybatis.dynamic.sql.VisitableCondition
 import org.mybatis.dynamic.sql.select.caseexpression.BasicWhenCondition
 import org.mybatis.dynamic.sql.select.caseexpression.ConditionBasedWhenCondition
-import org.mybatis.dynamic.sql.select.caseexpression.SearchedCaseModel.SearchedWhenCondition
+import org.mybatis.dynamic.sql.select.caseexpression.SearchedCaseWhenCondition
 import org.mybatis.dynamic.sql.select.caseexpression.SimpleCaseWhenCondition
 import org.mybatis.dynamic.sql.util.kotlin.GroupingCriteriaCollector
 import org.mybatis.dynamic.sql.util.kotlin.assertNull
@@ -30,12 +30,16 @@ class KSearchedCaseDSL : KElseDSL {
             assertNull(field, "ERROR.42") //$NON-NLS-1$
             field = value
         }
-    internal val whenConditions = mutableListOf<SearchedWhenCondition>()
+    internal val whenConditions = mutableListOf<SearchedCaseWhenCondition>()
 
-    fun `when`(dslCompleter: SearchedCaseCriteriaCollector.() -> Unit) {
-        val dsl = SearchedCaseCriteriaCollector().apply(dslCompleter)
-        whenConditions.add(SearchedWhenCondition(dsl.initialCriterion, dsl.subCriteria, dsl.thenValue))
-    }
+    fun `when`(dslCompleter: SearchedCaseCriteriaCollector.() -> Unit) =
+        SearchedCaseCriteriaCollector().apply(dslCompleter).run {
+            whenConditions.add(SearchedCaseWhenCondition.Builder().withInitialCriterion(initialCriterion)
+                .withSubCriteria(subCriteria)
+                .withThenValue(thenValue)
+                .build())
+
+        }
 
     override fun `else`(column: BasicColumn) {
         this.elseValue = column

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ void initialize(SqlCriterion sqlCriterion, List<AndOrCriteriaGroup> subCriteria)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`protected HavingModel buildModel() {`
`36`		`- return new HavingModel(getInitialCriterion(), subCriteria);`
	`36`	`+ return new HavingModel.Builder()`
	`37`	`+ .withInitialCriterion(getInitialCriterion())`
	`38`	`+ .withSubCriteria(subCriteria)`
	`39`	`+ .build();`
`37`	`40`	`}`
`38`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,10 @@ public T configureStatement(Consumer<StatementConfiguration> consumer) {`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`protected WhereModel buildModel() {`
`52`		`- return new WhereModel(getInitialCriterion(), subCriteria, statementConfiguration);`
	`52`	`+ return new WhereModel.Builder()`
	`53`	`+ .withInitialCriterion(getInitialCriterion())`
	`54`	`+ .withSubCriteria(subCriteria)`
	`55`	`+ .withStatementConfiguration(statementConfiguration)`
	`56`	`+ .build();`
`53`	`57`	`}`
`54`	`58`	`}`