Allow Conditions Increased Control over Rendering

jeffgbutler · jeffgbutler · commit 1ae2e43d103a · 2025-03-05T14:29:25.000-05:00
diff --git a/src/main/java/org/mybatis/dynamic/sql/AbstractColumnComparisonCondition.java b/src/main/java/org/mybatis/dynamic/sql/AbstractColumnComparisonCondition.java
@@ -15,6 +15,11 @@
  */
 package org.mybatis.dynamic.sql;
 
+import static org.mybatis.dynamic.sql.util.StringUtilities.spaceBefore;
+
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+
 public abstract class AbstractColumnComparisonCondition<T> implements VisitableCondition<T> {
 
     protected final BasicColumn rightColumn;
@@ -23,14 +28,10 @@ protected AbstractColumnComparisonCondition(BasicColumn rightColumn) {
         this.rightColumn = rightColumn;
     }
 
-    public BasicColumn rightColumn() {
-        return rightColumn;
-    }
+    public abstract String operator();
 
     @Override
-    public <R> R accept(ConditionVisitor<T, R> visitor) {
-        return visitor.visit(this);
+    public FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        return rightColumn.render(renderingContext).mapFragment(f -> operator() + spaceBefore(f));
     }
-
-    public abstract String operator();
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/AbstractListValueCondition.java b/src/main/java/org/mybatis/dynamic/sql/AbstractListValueCondition.java
@@ -23,6 +23,11 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.mybatis.dynamic.sql.render.RenderedParameterInfo;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+import org.mybatis.dynamic.sql.util.FragmentCollector;
+
 public abstract class AbstractListValueCondition<T> implements VisitableCondition<T> {
     protected final Collection<T> values;
 
@@ -39,19 +44,14 @@ public boolean isEmpty() {
         return values.isEmpty();
     }
 
-    @Override
-    public <R> R accept(ConditionVisitor<T, R> visitor) {
-        return visitor.visit(this);
-    }
-
     private <R> Collection<R> applyMapper(Function<? super T, ? extends R> mapper) {
         Objects.requireNonNull(mapper);
-        return values.stream().map(mapper).collect(Collectors.toList());
+        return values().map(mapper).collect(Collectors.toList());
     }
 
     private Collection<T> applyFilter(Predicate<? super T> predicate) {
         Objects.requireNonNull(predicate);
-        return values.stream().filter(predicate).toList();
+        return values().filter(predicate).toList();
     }
 
     protected <S extends AbstractListValueCondition<T>> S filterSupport(Predicate<? super T> predicate,
@@ -84,4 +84,20 @@ protected <R, S extends AbstractListValueCondition<R>> S mapSupport(Function<? s
     public abstract AbstractListValueCondition<T> filter(Predicate<? super T> predicate);
 
     public abstract String operator();
+
+    @Override
+    public FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        return values().map(v -> toFragmentAndParameters(v, renderingContext, leftColumn))
+                .collect(FragmentCollector.collect())
+                .toFragmentAndParameters(Collectors.joining(",", //$NON-NLS-1$
+                        operator() + " (", ")")); //$NON-NLS-1$ //$NON-NLS-2$
+    }
+
+    private FragmentAndParameters toFragmentAndParameters(T value, RenderingContext renderingContext,
+                                                          BindableColumn<T> leftColumn) {
+        RenderedParameterInfo parameterInfo = renderingContext.calculateParameterInfo(leftColumn);
+        return FragmentAndParameters.withFragment(parameterInfo.renderedPlaceHolder())
+                .withParameter(parameterInfo.parameterMapKey(), leftColumn.convertParameterType(value))
+                .build();
+    }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/AbstractNoValueCondition.java b/src/main/java/org/mybatis/dynamic/sql/AbstractNoValueCondition.java
@@ -18,12 +18,10 @@
 import java.util.function.BooleanSupplier;
 import java.util.function.Supplier;
 
-public abstract class AbstractNoValueCondition<T> implements VisitableCondition<T> {
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-    @Override
-    public <R> R accept(ConditionVisitor<T, R> visitor) {
-        return visitor.visit(this);
-    }
+public abstract class AbstractNoValueCondition<T> implements VisitableCondition<T> {
 
     protected <S extends AbstractNoValueCondition<?>> S filterSupport(BooleanSupplier booleanSupplier,
             Supplier<S> emptySupplier, S self) {
@@ -35,4 +33,9 @@ protected <S extends AbstractNoValueCondition<?>> S filterSupport(BooleanSupplie
     }
 
     public abstract String operator();
+
+    @Override
+    public FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        return FragmentAndParameters.fromFragment(operator());
+    }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/AbstractSingleValueCondition.java b/src/main/java/org/mybatis/dynamic/sql/AbstractSingleValueCondition.java
@@ -15,10 +15,16 @@
  */
 package org.mybatis.dynamic.sql;
 
+import static org.mybatis.dynamic.sql.util.StringUtilities.spaceBefore;
+
 import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 
+import org.mybatis.dynamic.sql.render.RenderedParameterInfo;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+
 public abstract class AbstractSingleValueCondition<T> implements VisitableCondition<T> {
     protected final T value;
 
@@ -30,11 +36,6 @@ public T value() {
         return value;
     }
 
-    @Override
-    public <R> R accept(ConditionVisitor<T, R> visitor) {
-        return visitor.visit(this);
-    }
-
     protected <S extends AbstractSingleValueCondition<T>> S filterSupport(Predicate<? super T> predicate,
             Supplier<S> emptySupplier, S self) {
         if (isEmpty()) {
@@ -64,4 +65,14 @@ protected <R, S extends AbstractSingleValueCondition<R>> S mapSupport(Function<?
     public abstract AbstractSingleValueCondition<T> filter(Predicate<? super T> predicate);
 
     public abstract String operator();
+
+    @Override
+    public FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        RenderedParameterInfo parameterInfo = renderingContext.calculateParameterInfo(leftColumn);
+        String finalFragment = operator() + spaceBefore(parameterInfo.renderedPlaceHolder());
+
+        return FragmentAndParameters.withFragment(finalFragment)
+                .withParameter(parameterInfo.parameterMapKey(), leftColumn.convertParameterType(value()))
+                .build();
+    }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/AbstractSubselectCondition.java b/src/main/java/org/mybatis/dynamic/sql/AbstractSubselectCondition.java
@@ -15,8 +15,11 @@
  */
 package org.mybatis.dynamic.sql;
 
+import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.select.SelectModel;
+import org.mybatis.dynamic.sql.select.render.SubQueryRenderer;
 import org.mybatis.dynamic.sql.util.Buildable;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
 public abstract class AbstractSubselectCondition<T> implements VisitableCondition<T> {
     private final SelectModel selectModel;
@@ -25,14 +28,15 @@ protected AbstractSubselectCondition(Buildable<SelectModel> selectModelBuilder)
         this.selectModel = selectModelBuilder.build();
     }
 
-    public SelectModel selectModel() {
-        return selectModel;
-    }
+    public abstract String operator();
 
     @Override
-    public <R> R accept(ConditionVisitor<T, R> visitor) {
-        return visitor.visit(this);
+    public FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        return SubQueryRenderer.withSelectModel(selectModel)
+                .withRenderingContext(renderingContext)
+                .withPrefix(operator() + " (") //$NON-NLS-1$
+                .withSuffix(")") //$NON-NLS-1$
+                .build()
+                .render();
     }
-
-    public abstract String operator();
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/AbstractTwoValueCondition.java b/src/main/java/org/mybatis/dynamic/sql/AbstractTwoValueCondition.java
@@ -15,12 +15,18 @@
  */
 package org.mybatis.dynamic.sql;
 
+import static org.mybatis.dynamic.sql.util.StringUtilities.spaceBefore;
+
 import java.util.function.BiFunction;
 import java.util.function.BiPredicate;
 import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 
+import org.mybatis.dynamic.sql.render.RenderedParameterInfo;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+
 public abstract class AbstractTwoValueCondition<T> implements VisitableCondition<T> {
     protected final T value1;
     protected final T value2;
@@ -38,11 +44,6 @@ public T value2() {
         return value2;
     }
 
-    @Override
-    public <R> R accept(ConditionVisitor<T, R> visitor) {
-        return visitor.visit(this);
-    }
-
     protected <S extends AbstractTwoValueCondition<T>> S filterSupport(BiPredicate<? super T, ? super T> predicate,
             Supplier<S> emptySupplier, S self) {
         if (isEmpty()) {
@@ -90,4 +91,20 @@ protected <R, S extends AbstractTwoValueCondition<R>> S mapSupport(Function<? su
     public abstract String operator1();
 
     public abstract String operator2();
+
+    @Override
+    public FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        RenderedParameterInfo parameterInfo1 = renderingContext.calculateParameterInfo(leftColumn);
+        RenderedParameterInfo parameterInfo2 = renderingContext.calculateParameterInfo(leftColumn);
+
+        String finalFragment = operator1()
+                + spaceBefore(parameterInfo1.renderedPlaceHolder())
+                + spaceBefore(operator2())
+                + spaceBefore(parameterInfo2.renderedPlaceHolder());
+
+        return FragmentAndParameters.withFragment(finalFragment)
+                .withParameter(parameterInfo1.parameterMapKey(), leftColumn.convertParameterType(value1()))
+                .withParameter(parameterInfo2.parameterMapKey(), leftColumn.convertParameterType(value2()))
+                .build();
+    }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/ConditionVisitor.java b/src/main/java/org/mybatis/dynamic/sql/ConditionVisitor.java
diff --git a/src/main/java/org/mybatis/dynamic/sql/VisitableCondition.java b/src/main/java/org/mybatis/dynamic/sql/VisitableCondition.java
@@ -16,10 +16,17 @@
 package org.mybatis.dynamic.sql;
 
 import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
 @FunctionalInterface
 public interface VisitableCondition<T> {
-    <R> R accept(ConditionVisitor<T, R> visitor);
+    FragmentAndParameters renderCondition(RenderingContext renderingContext, BindableColumn<T> leftColumn);
+
+    default FragmentAndParameters renderLeftColumn(RenderingContext renderingContext, BindableColumn<T> leftColumn) {
+        return leftColumn.alias()
+                .map(FragmentAndParameters::fromFragment)
+                .orElseGet(() -> leftColumn.render(renderingContext));
+    }
 
     /**
      * Subclasses can override this to inform the renderer if the condition should not be included
@@ -46,16 +53,4 @@ default boolean isEmpty() {
      * returns false.
      */
     default void renderingSkipped() {}
-
-    /**
-     * This method is called during rendering. Its purpose is to allow conditions to change
-     * the value of the rendered left column. This is primarily used in the case-insensitive conditions
-     * where we surround the rendered column with "upper(" and ")".
-     *
-     * @param renderedLeftColumn the rendered left column
-     * @return the altered column - by default no change is applied
-     */
-    default String overrideRenderedLeftColumn(String renderedLeftColumn) {
-        return renderedLeftColumn;
-    }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/select/render/SimpleCaseWhenConditionRenderer.java b/src/main/java/org/mybatis/dynamic/sql/select/render/SimpleCaseWhenConditionRenderer.java
@@ -28,20 +28,14 @@
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
 import org.mybatis.dynamic.sql.util.Validator;
-import org.mybatis.dynamic.sql.where.render.DefaultConditionVisitor;
 
 public class SimpleCaseWhenConditionRenderer<T> implements SimpleCaseWhenConditionVisitor<T, FragmentAndParameters> {
     private final RenderingContext renderingContext;
     private final BindableColumn<T> column;
-    private final DefaultConditionVisitor<T> conditionVisitor;
 
     public SimpleCaseWhenConditionRenderer(RenderingContext renderingContext, BindableColumn<T> column) {
         this.renderingContext = Objects.requireNonNull(renderingContext);
         this.column = Objects.requireNonNull(column);
-        conditionVisitor = new DefaultConditionVisitor.Builder<T>()
-                .withColumn(column)
-                .withRenderingContext(renderingContext)
-                .build();
     }
 
     @Override
@@ -68,7 +62,7 @@ private boolean shouldRender(VisitableCondition<T> condition) {
     }
 
     private FragmentAndParameters renderCondition(VisitableCondition<T> condition) {
-        return condition.accept(conditionVisitor);
+        return condition.renderCondition(renderingContext, column);
     }
 
     private FragmentAndParameters renderBasicValue(T value) {
diff --git a/src/main/java/org/mybatis/dynamic/sql/where/condition/CaseInsensitiveVisitableCondition.java b/src/main/java/org/mybatis/dynamic/sql/where/condition/CaseInsensitiveVisitableCondition.java
@@ -15,12 +15,17 @@
  */
 package org.mybatis.dynamic.sql.where.condition;
 
+import org.mybatis.dynamic.sql.BindableColumn;
 import org.mybatis.dynamic.sql.VisitableCondition;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
 public interface CaseInsensitiveVisitableCondition extends VisitableCondition<String> {
 
     @Override
-    default String overrideRenderedLeftColumn(String renderedLeftColumn) {
-        return "upper(" + renderedLeftColumn + ")"; //$NON-NLS-1$ //$NON-NLS-2$
+    default FragmentAndParameters renderLeftColumn(RenderingContext renderingContext,
+                                                   BindableColumn<String> leftColumn) {
+        return VisitableCondition.super.renderLeftColumn(renderingContext, leftColumn)
+                .mapFragment(s -> "upper(" + s + ")"); //$NON-NLS-1$ //$NON-NLS-2$
     }
 }
diff --git a/src/main/java/org/mybatis/dynamic/sql/where/render/ColumnAndConditionRenderer.java b/src/main/java/org/mybatis/dynamic/sql/where/render/ColumnAndConditionRenderer.java
@@ -29,31 +29,20 @@ public class ColumnAndConditionRenderer<T> {
     private final BindableColumn<T> column;
     private final VisitableCondition<T> condition;
     private final RenderingContext renderingContext;
-    private final DefaultConditionVisitor<T> visitor;
 
     private ColumnAndConditionRenderer(Builder<T> builder) {
         column = Objects.requireNonNull(builder.column);
         condition = Objects.requireNonNull(builder.condition);
         renderingContext = Objects.requireNonNull(builder.renderingContext);
-        visitor = DefaultConditionVisitor.withColumn(column)
-                .withRenderingContext(renderingContext)
-                .build();
     }
 
     public FragmentAndParameters render() {
         FragmentCollector fc = new FragmentCollector();
-        fc.add(renderLeftColumn());
-        fc.add(condition.accept(visitor));
+        fc.add(condition.renderLeftColumn(renderingContext, column));
+        fc.add(condition.renderCondition(renderingContext, column));
         return fc.toFragmentAndParameters(Collectors.joining(" ")); //$NON-NLS-1$
     }
 
-    private FragmentAndParameters renderLeftColumn() {
-        return column.alias()
-                .map(FragmentAndParameters::fromFragment)
-                .orElseGet(() -> column.render(renderingContext))
-                .mapFragment(condition::overrideRenderedLeftColumn);
-    }
-
     public static class Builder<T> {
         private @Nullable BindableColumn<T> column;
         private @Nullable VisitableCondition<T> condition;
diff --git a/src/main/java/org/mybatis/dynamic/sql/where/render/DefaultConditionVisitor.java b/src/main/java/org/mybatis/dynamic/sql/where/render/DefaultConditionVisitor.java
diff --git a/src/test/java/examples/mysql/IsLikeEscape.java b/src/test/java/examples/mysql/IsLikeEscape.java
diff --git a/src/test/java/examples/mysql/MySQLTest.java b/src/test/java/examples/mysql/MySQLTest.java
