Rename VisitableCondition to RenderableCondition

Conditions are no longer rendered via a Visitor, so the new name makes more sense

Author: jeffgbutler

CHANGELOG.md

@@ -100,6 +100,10 @@ Runtime behavior changes:
   these concepts for different databases it simply adds known clauses to a generated SQL statement. You should always
   test to make sure these functions work in your target database. Currently, we support, and test, the options
   supported by PostgreSQL.
+- Rendering for all the conditions (isEqualTo, etc.) has changed. This should be transparent to most users unless you
+  have coded a direct implementation of `VisitableCondition`. The change makes it easier to code custom conditions that
+  are not supported by the library out of the box. The statement renderers now call methods `renderCondition` and
+  `renderLeftColumn` that you can override to implement any rendering you need.  
 
 ## Release 1.5.2 - June 3, 2024
 

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

@@ -20,7 +20,7 @@
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-public abstract class AbstractColumnComparisonCondition<T> implements VisitableCondition<T> {
+public abstract class AbstractColumnComparisonCondition<T> implements RenderableCondition<T> {
 
     protected final BasicColumn rightColumn;
 

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

@@ -28,7 +28,7 @@
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
 
-public abstract class AbstractListValueCondition<T> implements VisitableCondition<T> {
+public abstract class AbstractListValueCondition<T> implements RenderableCondition<T> {
     protected final Collection<T> values;
 
     protected AbstractListValueCondition(Collection<T> values) {

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

@@ -21,7 +21,7 @@
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-public abstract class AbstractNoValueCondition<T> implements VisitableCondition<T> {
+public abstract class AbstractNoValueCondition<T> implements RenderableCondition<T> {
 
     protected <S extends AbstractNoValueCondition<?>> S filterSupport(BooleanSupplier booleanSupplier,
             Supplier<S> emptySupplier, S self) {

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

@@ -25,7 +25,7 @@
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-public abstract class AbstractSingleValueCondition<T> implements VisitableCondition<T> {
+public abstract class AbstractSingleValueCondition<T> implements RenderableCondition<T> {
     protected final T value;
 
     protected AbstractSingleValueCondition(T value) {

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

@@ -21,7 +21,7 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-public abstract class AbstractSubselectCondition<T> implements VisitableCondition<T> {
+public abstract class AbstractSubselectCondition<T> implements RenderableCondition<T> {
     private final SelectModel selectModel;
 
     protected AbstractSubselectCondition(Buildable<SelectModel> selectModelBuilder) {

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

@@ -27,7 +27,7 @@
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-public abstract class AbstractTwoValueCondition<T> implements VisitableCondition<T> {
+public abstract class AbstractTwoValueCondition<T> implements RenderableCondition<T> {
     protected final T value1;
     protected final T value2;
 

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

@@ -21,7 +21,7 @@
 
 public class ColumnAndConditionCriterion<T> extends SqlCriterion {
     private final BindableColumn<T> column;
-    private final VisitableCondition<T> condition;
+    private final RenderableCondition<T> condition;
 
     private ColumnAndConditionCriterion(Builder<T> builder) {
         super(builder);
@@ -33,7 +33,7 @@ public BindableColumn<T> column() {
         return column;
     }
 
-    public VisitableCondition<T> condition() {
+    public RenderableCondition<T> condition() {
         return condition;
     }
 
@@ -48,14 +48,14 @@ public static <T> Builder<T> withColumn(BindableColumn<T> column) {
 
     public static class Builder<T> extends AbstractBuilder<Builder<T>> {
         private @Nullable BindableColumn<T> column;
-        private @Nullable VisitableCondition<T> condition;
+        private @Nullable RenderableCondition<T> condition;
 
         public Builder<T> withColumn(BindableColumn<T> column) {
             this.column = column;
             return this;
         }
 
-        public Builder<T> withCondition(VisitableCondition<T> condition) {
+        public Builder<T> withCondition(RenderableCondition<T> condition) {
             this.condition = condition;
             return this;
         }

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

@@ -250,7 +250,7 @@ static WhereDSL.StandaloneWhereFinisher where() {
         return new WhereDSL().where();
     }
 
-    static <T> WhereDSL.StandaloneWhereFinisher where(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> WhereDSL.StandaloneWhereFinisher where(BindableColumn<T> column, RenderableCondition<T> condition,
                                                       AndOrCriteriaGroup... subCriteria) {
         return new WhereDSL().where(column, condition, subCriteria);
     }
@@ -263,7 +263,7 @@ static WhereDSL.StandaloneWhereFinisher where(ExistsPredicate existsPredicate, A
         return new WhereDSL().where(existsPredicate, subCriteria);
     }
 
-    static <T> HavingDSL.StandaloneHavingFinisher having(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> HavingDSL.StandaloneHavingFinisher having(BindableColumn<T> column, RenderableCondition<T> condition,
                                               AndOrCriteriaGroup... subCriteria) {
         return new HavingDSL().having(column, condition, subCriteria);
     }
@@ -273,12 +273,12 @@ static HavingDSL.StandaloneHavingFinisher having(SqlCriterion initialCriterion,
     }
 
     // where condition connectors
-    static <T> CriteriaGroup group(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> CriteriaGroup group(BindableColumn<T> column, RenderableCondition<T> condition,
                                    AndOrCriteriaGroup... subCriteria) {
         return group(column, condition, Arrays.asList(subCriteria));
     }
 
-    static <T> CriteriaGroup group(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> CriteriaGroup group(BindableColumn<T> column, RenderableCondition<T> condition,
                                    List<AndOrCriteriaGroup> subCriteria) {
         return new CriteriaGroup.Builder()
                 .withInitialCriterion(new ColumnAndConditionCriterion.Builder<T>().withColumn(column)
@@ -316,12 +316,12 @@ static CriteriaGroup group(List<AndOrCriteriaGroup> subCriteria) {
                 .build();
     }
 
-    static <T> NotCriterion not(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> NotCriterion not(BindableColumn<T> column, RenderableCondition<T> condition,
                                 AndOrCriteriaGroup... subCriteria) {
         return not(column, condition, Arrays.asList(subCriteria));
     }
 
-    static <T> NotCriterion not(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> NotCriterion not(BindableColumn<T> column, RenderableCondition<T> condition,
                                 List<AndOrCriteriaGroup> subCriteria) {
         return new NotCriterion.Builder()
                 .withInitialCriterion(new ColumnAndConditionCriterion.Builder<T>().withColumn(column)
@@ -359,7 +359,7 @@ static NotCriterion not(List<AndOrCriteriaGroup> subCriteria) {
                 .build();
     }
 
-    static <T> AndOrCriteriaGroup or(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> AndOrCriteriaGroup or(BindableColumn<T> column, RenderableCondition<T> condition,
                                      AndOrCriteriaGroup... subCriteria) {
         return new AndOrCriteriaGroup.Builder()
                 .withInitialCriterion(ColumnAndConditionCriterion.withColumn(column)
@@ -394,7 +394,7 @@ static AndOrCriteriaGroup or(List<AndOrCriteriaGroup> subCriteria) {
                 .build();
     }
 
-    static <T> AndOrCriteriaGroup and(BindableColumn<T> column, VisitableCondition<T> condition,
+    static <T> AndOrCriteriaGroup and(BindableColumn<T> column, RenderableCondition<T> condition,
                                       AndOrCriteriaGroup... subCriteria) {
         return new AndOrCriteriaGroup.Builder()
                 .withInitialCriterion(ColumnAndConditionCriterion.withColumn(column)
@@ -430,7 +430,7 @@ static AndOrCriteriaGroup and(List<AndOrCriteriaGroup> subCriteria) {
     }
 
     // join support
-    static <T> ColumnAndConditionCriterion<T> on(BindableColumn<T> joinColumn, VisitableCondition<T> joinCondition) {
+    static <T> ColumnAndConditionCriterion<T> on(BindableColumn<T> joinColumn, RenderableCondition<T> joinCondition) {
         return ColumnAndConditionCriterion.withColumn(joinColumn)
                 .withCondition(joinCondition)
                 .build();
@@ -506,7 +506,7 @@ static Sum<Object> sum(BasicColumn column) {
         return Sum.of(column);
     }
 
-    static <T> Sum<T> sum(BindableColumn<T> column, VisitableCondition<T> condition) {
+    static <T> Sum<T> sum(BindableColumn<T> column, RenderableCondition<T> condition) {
         return Sum.of(column, condition);
     }
 

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

@@ -16,41 +16,21 @@
 package org.mybatis.dynamic.sql;
 
 import org.mybatis.dynamic.sql.render.RenderingContext;
-import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
-@FunctionalInterface
-public interface VisitableCondition<T> {
-    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
-     * in the rendered SQL.  Typically, conditions will not render if they are empty.
-     *
-     * @return true if the condition should render.
-     */
-    default boolean shouldRender(RenderingContext renderingContext) {
-        return !isEmpty();
-    }
-
-    /**
-     * Subclasses can override this to indicate whether the condition is considered empty. This is primarily used in
-     * map and filter operations - the map and filter functions will not be applied if the condition is empty.
-     *
-     * @return true if the condition is empty.
-     */
-    default boolean isEmpty() {
-        return false;
-    }
-
-    /**
-     * This method will be called during rendering when {@link VisitableCondition#shouldRender(RenderingContext)}
-     * returns false.
-     */
-    default void renderingSkipped() {}
-}
+/**
+ * Deprecated interface.
+ *
+ * <p>Conditions are no longer rendered with a visitor, so the name is misleading. This change makes it far easier
+ * to implement custom conditions for functionality not supplied out of the box by the library.
+ *
+ * <p>If you created any direct implementations of this interface, you will need to change the rendering functions.
+ * The library now calls {@link RenderableCondition#renderCondition(RenderingContext, BindableColumn)} and
+ * {@link RenderableCondition#renderLeftColumn(RenderingContext, BindableColumn)} instead of the previous methods
+ * like <code>operator</code>, <code>value</code>, etc. Subclasses of the supplied abstract conditions should continue
+ * to function as before.
+ *
+ * @param <T> the Java type related to the column this condition relates to. Used primarily for compiler type checking
+ * @deprecated since 2.0.0. Please use {@link RenderableCondition} instead.
+ */
+@Deprecated(since = "2.0.0", forRemoval = true)
+public interface VisitableCondition<T> extends RenderableCondition<T> { }

src/main/java/org/mybatis/dynamic/sql/common/AbstractBooleanExpressionDSL.java

@@ -26,20 +26,20 @@
 import org.mybatis.dynamic.sql.CriteriaGroup;
 import org.mybatis.dynamic.sql.ExistsCriterion;
 import org.mybatis.dynamic.sql.ExistsPredicate;
+import org.mybatis.dynamic.sql.RenderableCondition;
 import org.mybatis.dynamic.sql.SqlCriterion;
-import org.mybatis.dynamic.sql.VisitableCondition;
 import org.mybatis.dynamic.sql.util.Validator;
 
 public abstract class AbstractBooleanExpressionDSL<T extends AbstractBooleanExpressionDSL<T>> {
     private @Nullable SqlCriterion initialCriterion;
     protected final List<AndOrCriteriaGroup> subCriteria = new ArrayList<>();
 
-    public <S> T and(BindableColumn<S> column, VisitableCondition<S> condition,
+    public <S> T and(BindableColumn<S> column, RenderableCondition<S> condition,
                      AndOrCriteriaGroup... subCriteria) {
         return and(column, condition, Arrays.asList(subCriteria));
     }
 
-    public <S> T and(BindableColumn<S> column, VisitableCondition<S> condition,
+    public <S> T and(BindableColumn<S> column, RenderableCondition<S> condition,
                      List<AndOrCriteriaGroup> subCriteria) {
         addSubCriteria("and", buildCriterion(column, condition), subCriteria); //$NON-NLS-1$
         return getThis();
@@ -68,12 +68,12 @@ public T and(List<AndOrCriteriaGroup> criteria) {
         return getThis();
     }
 
-    public <S> T or(BindableColumn<S> column, VisitableCondition<S> condition,
+    public <S> T or(BindableColumn<S> column, RenderableCondition<S> condition,
                     AndOrCriteriaGroup... subCriteria) {
         return or(column, condition, Arrays.asList(subCriteria));
     }
 
-    public <S> T or(BindableColumn<S> column, VisitableCondition<S> condition,
+    public <S> T or(BindableColumn<S> column, RenderableCondition<S> condition,
                     List<AndOrCriteriaGroup> subCriteria) {
         addSubCriteria("or", buildCriterion(column, condition), subCriteria); //$NON-NLS-1$
         return getThis();
@@ -102,7 +102,7 @@ public T or(List<AndOrCriteriaGroup> criteria) {
         return getThis();
     }
 
-    private <R> SqlCriterion buildCriterion(BindableColumn<R> column, VisitableCondition<R> condition) {
+    private <R> SqlCriterion buildCriterion(BindableColumn<R> column, RenderableCondition<R> condition) {
         return ColumnAndConditionCriterion.withColumn(column).withCondition(condition).build();
     }
 

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

@@ -22,17 +22,17 @@
 import org.mybatis.dynamic.sql.BindableColumn;
 import org.mybatis.dynamic.sql.ColumnAndConditionCriterion;
 import org.mybatis.dynamic.sql.CriteriaGroup;
+import org.mybatis.dynamic.sql.RenderableCondition;
 import org.mybatis.dynamic.sql.SqlCriterion;
-import org.mybatis.dynamic.sql.VisitableCondition;
 
 public interface AbstractHavingStarter<F extends AbstractHavingFinisher<?>> {
 
-    default <T> F having(BindableColumn<T> column, VisitableCondition<T> condition,
+    default <T> F having(BindableColumn<T> column, RenderableCondition<T> condition,
                         AndOrCriteriaGroup... subCriteria) {
         return having(column, condition, Arrays.asList(subCriteria));
     }
 
-    default <T> F having(BindableColumn<T> column, VisitableCondition<T> condition,
+    default <T> F having(BindableColumn<T> column, RenderableCondition<T> condition,
                         List<AndOrCriteriaGroup> subCriteria) {
         SqlCriterion sqlCriterion = ColumnAndConditionCriterion.withColumn(column)
                 .withCondition(condition)

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

@@ -28,10 +28,10 @@
 import org.mybatis.dynamic.sql.BindableColumn;
 import org.mybatis.dynamic.sql.ColumnAndConditionCriterion;
 import org.mybatis.dynamic.sql.CriteriaGroup;
+import org.mybatis.dynamic.sql.RenderableCondition;
 import org.mybatis.dynamic.sql.SortSpecification;
 import org.mybatis.dynamic.sql.SqlTable;
 import org.mybatis.dynamic.sql.TableExpression;
-import org.mybatis.dynamic.sql.VisitableCondition;
 import org.mybatis.dynamic.sql.common.AbstractBooleanExpressionDSL;
 import org.mybatis.dynamic.sql.configuration.StatementConfiguration;
 import org.mybatis.dynamic.sql.select.join.JoinSpecification;
@@ -324,11 +324,11 @@ public JoinSpecificationStarter(TableExpression joinTable, JoinType joinType) {
             this.joinType = joinType;
         }
 
-        public <T> JoinSpecificationFinisher on(BindableColumn<T> joinColumn, VisitableCondition<T> joinCondition) {
+        public <T> JoinSpecificationFinisher on(BindableColumn<T> joinColumn, RenderableCondition<T> joinCondition) {
             return new JoinSpecificationFinisher(joinTable, joinColumn, joinCondition, joinType);
         }
 
-        public <T> JoinSpecificationFinisher on(BindableColumn<T> joinColumn, VisitableCondition<T> onJoinCondition,
+        public <T> JoinSpecificationFinisher on(BindableColumn<T> joinColumn, RenderableCondition<T> onJoinCondition,
                                                 AndOrCriteriaGroup... subCriteria) {
             return new JoinSpecificationFinisher(joinTable, joinColumn, onJoinCondition, joinType, subCriteria);
         }
@@ -343,7 +343,7 @@ public class JoinSpecificationFinisher
         private final JoinType joinType;
 
         public <T> JoinSpecificationFinisher(TableExpression table, BindableColumn<T> joinColumn,
-                VisitableCondition<T> joinCondition, JoinType joinType) {
+                                             RenderableCondition<T> joinCondition, JoinType joinType) {
             this.table = table;
             this.joinType = joinType;
             addJoinSpecificationSupplier(this::buildJoinSpecification);
@@ -356,7 +356,8 @@ public <T> JoinSpecificationFinisher(TableExpression table, BindableColumn<T> jo
         }
 
         public <T> JoinSpecificationFinisher(TableExpression table, BindableColumn<T> joinColumn,
-                VisitableCondition<T> joinCondition, JoinType joinType, AndOrCriteriaGroup... subCriteria) {
+                                             RenderableCondition<T> joinCondition, JoinType joinType,
+                                             AndOrCriteriaGroup... subCriteria) {
             this.table = table;
             this.joinType = joinType;
             addJoinSpecificationSupplier(this::buildJoinSpecification);

src/main/java/org/mybatis/dynamic/sql/select/aggregate/Sum.java

@@ -19,7 +19,7 @@
 
 import org.mybatis.dynamic.sql.BasicColumn;
 import org.mybatis.dynamic.sql.BindableColumn;
-import org.mybatis.dynamic.sql.VisitableCondition;
+import org.mybatis.dynamic.sql.RenderableCondition;
 import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.select.function.AbstractUniTypeFunction;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
@@ -34,7 +34,7 @@ private Sum(BasicColumn column) {
         renderer = rc -> column.render(rc).mapFragment(this::applyAggregate);
     }
 
-    private Sum(BindableColumn<T> column, VisitableCondition<T> condition) {
+    private Sum(BindableColumn<T> column, RenderableCondition<T> condition) {
         super(column);
         renderer = rc -> {
             Validator.assertTrue(condition.shouldRender(rc), "ERROR.37", "sum"); //$NON-NLS-1$ //$NON-NLS-2$
@@ -76,7 +76,7 @@ public static Sum<Object> of(BasicColumn column) {
         return new Sum<>(column);
     }
 
-    public static <T> Sum<T> of(BindableColumn<T> column, VisitableCondition<T> condition) {
+    public static <T> Sum<T> of(BindableColumn<T> column, RenderableCondition<T> condition) {
         return new Sum<>(column, condition);
     }
 }