Create UserDefinedCriteria (#1345)

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/context/Criterion.java

@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Consumer;
+import org.seasar.doma.jdbc.criteria.declaration.UserDefinedCriteriaContext;
 import org.seasar.doma.jdbc.criteria.option.LikeOption;
 import org.seasar.doma.jdbc.criteria.tuple.Tuple2;
 import org.seasar.doma.jdbc.criteria.tuple.Tuple3;
@@ -448,6 +450,20 @@ public void accept(Visitor visitor) {
     }
   }
 
+  class UserDefined implements Criterion {
+    public final Consumer<UserDefinedCriteriaContext.Builder> builderBlock;
+
+    public UserDefined(Consumer<UserDefinedCriteriaContext.Builder> builderBlock) {
+      Objects.requireNonNull(builderBlock);
+      this.builderBlock = builderBlock;
+    }
+
+    @Override
+    public void accept(Visitor visitor) {
+      visitor.visit(this);
+    }
+  }
+
   interface Visitor {
     void visit(Eq criterion);
 
@@ -504,5 +520,7 @@ interface Visitor {
     void visit(Or criterion);
 
     void visit(Not criterion);
+
+    void visit(UserDefined criterion);
   }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/declaration/ComparisonDeclaration.java

@@ -903,6 +903,25 @@ public void or(Runnable block) {
     runBlock(block, Criterion.Or::new);
   }
 
+  /**
+   * Add a declaring a user-defined extension.
+   *
+   * @param <EXTENSION> the type of the user-defined extension
+   * @param construct function that generates user-defined extension.
+   * @param extensionBlock block that can use user-defined extension.
+   * @throws NullPointerException if {@code construct} or {@code extensionBlock} is null
+   */
+  public <EXTENSION> void extension(
+      Function<UserDefinedCriteriaContext, EXTENSION> construct,
+      Consumer<EXTENSION> extensionBlock) {
+    Objects.requireNonNull(construct);
+    Objects.requireNonNull(extensionBlock);
+
+    var extension =
+        construct.apply(builderBlock -> this.add(new Criterion.UserDefined(builderBlock)));
+    extensionBlock.accept(extension);
+  }
+
   /**
    * Add a {@code NOT} operator.
    *

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/declaration/UserDefinedCriteriaContext.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright Doma 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.seasar.doma.jdbc.criteria.declaration;
+
+import java.util.function.Consumer;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
+import org.seasar.doma.jdbc.dialect.Dialect;
+
+/** Represents a user-defined comparison criteria declaration. */
+@FunctionalInterface
+public interface UserDefinedCriteriaContext {
+  /**
+   * Adds a user-defined operation to the criteria declaration by accepting a function that
+   * configures the provided {@code Builder}.
+   *
+   * @param builderBlock a {@link Consumer} used to configure the {@code Builder} for appending SQL
+   *     code, expressions, or other operations
+   */
+  void add(Consumer<Builder> builderBlock);
+
+  interface Builder {
+    /**
+     * Appends SQL code to the declaration.
+     *
+     * @param sql the SQL code to be appended
+     */
+    void appendSql(String sql);
+
+    /**
+     * cutback SQL.
+     *
+     * @param length the length to cutback the SQL code
+     */
+    void cutBackSql(int length);
+
+    /**
+     * Append a expression.
+     *
+     * @param propertyMetamodel the {@link PropertyMetamodel} to be added as a expression in the
+     *     declaration
+     */
+    void appendExpression(PropertyMetamodel<?> propertyMetamodel);
+
+    /**
+     * Appends a parameter.
+     *
+     * @param propertyMetamodel the {@link PropertyMetamodel} to be added as a expression in the
+     *     declaration
+     * @param value the value of the property
+     * @param <PROPERTY> the type of the property
+     */
+    <PROPERTY> void appendParameter(PropertyMetamodel<PROPERTY> propertyMetamodel, PROPERTY value);
+
+    /**
+     * Represents the specific database dialect. This is utilized to modify user-defined expressions
+     * based on the dialect in use.
+     */
+    Dialect getDialect();
+  }
+}

doma-core/src/main/java/org/seasar/doma/jdbc/criteria/query/BuilderSupport.java

@@ -20,6 +20,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.function.BiFunction;
+import java.util.function.Consumer;
 import java.util.function.Function;
 import org.seasar.doma.DomaException;
 import org.seasar.doma.expr.ExpressionFunctions;
@@ -36,6 +37,7 @@
 import org.seasar.doma.jdbc.criteria.context.SelectContext;
 import org.seasar.doma.jdbc.criteria.context.SetOperationContext;
 import org.seasar.doma.jdbc.criteria.context.WithContext;
+import org.seasar.doma.jdbc.criteria.declaration.UserDefinedCriteriaContext;
 import org.seasar.doma.jdbc.criteria.expression.AggregateFunction;
 import org.seasar.doma.jdbc.criteria.expression.AliasExpression;
 import org.seasar.doma.jdbc.criteria.expression.ArithmeticExpression;
@@ -49,6 +51,7 @@
 import org.seasar.doma.jdbc.criteria.option.LikeOption;
 import org.seasar.doma.jdbc.criteria.tuple.Tuple2;
 import org.seasar.doma.jdbc.criteria.tuple.Tuple3;
+import org.seasar.doma.jdbc.dialect.Dialect;
 import org.seasar.doma.jdbc.entity.EntityPropertyType;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.entity.Property;
@@ -65,6 +68,7 @@ public class BuilderSupport {
   private final PropertyMetamodelVisitor propertyMetamodelVisitor;
   private final UserDefinedExpressionDeclarationItemVisitor
       userDefinedExpressionDeclarationItemVisitor;
+  private final UserDefinedCriteriaContextBuilder userDefinedCriteriaContextBuilder;
 
   public BuilderSupport(
       Config config,
@@ -79,6 +83,7 @@ public BuilderSupport(
     this.propertyMetamodelVisitor = new PropertyMetamodelVisitor();
     this.userDefinedExpressionDeclarationItemVisitor =
         new UserDefinedExpressionDeclarationItemVisitor();
+    this.userDefinedCriteriaContextBuilder = new UserDefinedCriteriaContextBuilder();
   }
 
   public void with(List<WithContext> withContexts) {
@@ -424,6 +429,11 @@ public void visit(Criterion.Not criterion) {
       not(criterion.criterionList);
     }
 
+    @Override
+    public void visit(Criterion.UserDefined criterion) {
+      extension(criterion.builderBlock);
+    }
+
     private void comparison(Operand.Prop left, Operand right, String op) {
       column(left);
       buf.appendSql(" " + op + " ");
@@ -690,6 +700,10 @@ private void not(List<Criterion> criterionList) {
         buf.appendSql(")");
       }
     }
+
+    private void extension(Consumer<UserDefinedCriteriaContext.Builder> builderBlock) {
+      builderBlock.accept(userDefinedCriteriaContextBuilder);
+    }
   }
 
   class PropertyMetamodelVisitor
@@ -924,4 +938,37 @@ public void visit(UserDefinedExpression.DeclarationItem.CutbackSql cutbackSql) {
       buf.cutBackSql(cutbackSql.get());
     }
   }
+
+  class UserDefinedCriteriaContextBuilder implements UserDefinedCriteriaContext.Builder {
+    @Override
+    public void appendSql(String sql) {
+      Objects.requireNonNull(sql);
+      buf.appendSql(sql);
+    }
+
+    @Override
+    public void cutBackSql(int length) {
+      buf.cutBackSql(length);
+    }
+
+    @Override
+    public void appendExpression(PropertyMetamodel<?> propertyMetamodel) {
+      Objects.requireNonNull(propertyMetamodel);
+      propertyMetamodel.accept(propertyMetamodelVisitor);
+    }
+
+    @Override
+    public <PROPERTY> void appendParameter(
+        PropertyMetamodel<PROPERTY> propertyMetamodel, PROPERTY value) {
+      Objects.requireNonNull(propertyMetamodel);
+      var param = new Operand.Param(propertyMetamodel, value);
+      var parameter = param.createInParameter(config);
+      param(parameter);
+    }
+
+    @Override
+    public Dialect getDialect() {
+      return config.getDialect();
+    }
+  }
 }

doma-core/src/test/java/org/seasar/doma/jdbc/criteria/MyExtension.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright Doma 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.seasar.doma.jdbc.criteria;
+
+import org.seasar.doma.jdbc.criteria.declaration.UserDefinedCriteriaContext;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
+
+record MyExtension(UserDefinedCriteriaContext context) {
+  public void likeMultiple(PropertyMetamodel<String> propertyMetamodel, String... patterns) {
+    context.add(
+        (b) -> {
+          for (String pattern : patterns) {
+            b.appendExpression(propertyMetamodel);
+            b.appendSql(" like ");
+            b.appendParameter(propertyMetamodel, "%" + pattern + "%");
+            b.appendSql(" or ");
+          }
+          b.cutBackSql(4);
+        });
+  }
+
+  public void eq2(PropertyMetamodel<String> propertyMetamodel, String pattern) {
+    context.add(
+        (b) -> {
+          b.appendExpression(propertyMetamodel);
+          b.appendSql(" = ");
+          b.appendParameter(propertyMetamodel, pattern);
+        });
+  }
+}