Add SQLite support to the Criteria API (#1259)

Author: nakamura-to

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

@@ -5,22 +5,53 @@
 import java.util.Objects;
 import java.util.function.BiFunction;
 import java.util.function.Function;
+import org.seasar.doma.jdbc.Config;
 import org.seasar.doma.jdbc.criteria.context.Context;
 import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
 import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 
+/**
+ * The {@code AliasManager} class is responsible for managing alias mappings for entity and property
+ * metamodels. It helps in generating and retrieving unique aliases for entities and their
+ * associated properties to ensure consistency in database queries.
+ *
+ * <p>This class provides both static factory methods for instantiation and functionality to link to
+ * a parent {@code AliasManager} to resolve aliases hierarchically.
+ */
 public class AliasManager {
-  private final AliasManager parent;
-  private final Map<EntityMetamodel<?>, String> entityAliasMap = new HashMap<>();
-  private final Map<PropertyMetamodel<?>, String> propertyAliasMap = new HashMap<>();
+  protected final Context context;
+  protected final AliasManager parent;
+  protected final Map<EntityMetamodel<?>, String> entityAliasMap = new HashMap<>();
+  protected final Map<PropertyMetamodel<?>, String> propertyAliasMap = new HashMap<>();
   private final int index;
 
+  /**
+   * Constructs an instance of {@code AliasManager}.
+   *
+   * <p>This constructor is marked as {@code @Deprecated}. Usage of {@code of(Config, Context)} or
+   * {@code of(Config, Context, AliasManager)} is recommended.
+   *
+   * @param context the context containing the entity metamodels; must not be null
+   * @throws NullPointerException if {@code context} is null
+   */
+  @Deprecated
   public AliasManager(Context context) {
     this(context, null);
   }
 
+  /**
+   * Constructs an instance of {@code AliasManager}.
+   *
+   * <p>This constructor is marked as {@code @Deprecated}. Usage of {@code of(Config, Context)} or
+   * {@code of(Config, Context, AliasManager)} is recommended.
+   *
+   * @param context the context containing the entity metamodels; must not be null
+   * @param parent the parent {@code AliasManager}, or null if none
+   * @throws NullPointerException if {@code context} is null
+   */
+  @Deprecated
   public AliasManager(Context context, AliasManager parent) {
-    Objects.requireNonNull(context);
+    this.context = Objects.requireNonNull(context);
     this.parent = parent;
     int index = parent != null ? parent.index : 0;
     for (EntityMetamodel<?> entityMetamodel : context.getEntityMetamodels()) {
@@ -34,10 +65,24 @@ public AliasManager(Context context, AliasManager parent) {
     this.index = index;
   }
 
+  /**
+   * Retrieves the alias corresponding to the given {@code EntityMetamodel}.
+   *
+   * @param entityMetamodel the entity metamodel for which the alias is to be retrieved; must not be
+   *     null
+   * @return the alias as a {@code String}, or {@code null} if no alias is found
+   */
   public String getAlias(EntityMetamodel<?> entityMetamodel) {
     return getAlias(entityMetamodel, AliasManager::getAlias, entityAliasMap::get);
   }
 
+  /**
+   * Retrieves the alias for the given {@code PropertyMetamodel}.
+   *
+   * @param propertyMetamodel the property metamodel for which the alias is to be retrieved; must
+   *     not be null
+   * @return the alias as a {@code String}, or {@code null} if no alias is found
+   */
   public String getAlias(PropertyMetamodel<?> propertyMetamodel) {
     return getAlias(propertyMetamodel, AliasManager::getAlias, propertyAliasMap::get);
   }
@@ -54,4 +99,52 @@ private <KEY> String getAlias(
     }
     return getCurrentAlias.apply(key);
   }
+
+  protected AliasManager asParent() {
+    return this;
+  }
+
+  /**
+   * Creates a new instance of {@code AliasManager} using the provided configuration and context.
+   *
+   * @param config the runtime configuration for DAOs; must not be null
+   * @param context the context containing the entity metamodels; must not be null
+   * @return a new instance of {@code AliasManager}
+   * @throws NullPointerException if {@code config} or {@code context} is null
+   */
+  public static AliasManager create(Config config, Context context) {
+    // The config will be used in future refactoring.
+    Objects.requireNonNull(config);
+    return new AliasManager(context);
+  }
+
+  /**
+   * Creates an empty instance of {@code AliasManager} with the provided configuration and context.
+   *
+   * @param config the runtime configuration for DAOs; must not be null
+   * @param context the context containing the entity metamodels; must not be null
+   * @return a new instance of {@code EmptyAliasManager} with a default aliasing strategy
+   * @throws NullPointerException if {@code config} or {@code context} is null
+   */
+  public static AliasManager createEmpty(Config config, Context context) {
+    return new EmptyAliasManager(config, context);
+  }
+
+  /**
+   * Creates a child instance of {@code AliasManager} using the provided configuration, context, and
+   * parent {@code AliasManager}.
+   *
+   * @param config the runtime configuration for DAOs; must not be null
+   * @param context the context containing the entity metamodels; must not be null
+   * @param parent the parent {@code AliasManager}; must not be null
+   * @return a new child instance of {@code AliasManager}
+   * @throws NullPointerException if {@code config}, {@code context}, or {@code parent} is null
+   */
+  public static AliasManager createChild(Config config, Context context, AliasManager parent) {
+    // The config will be used in future refactoring.
+    Objects.requireNonNull(config);
+    Objects.requireNonNull(context);
+    Objects.requireNonNull(parent);
+    return new AliasManager(context, parent.asParent());
+  }
 }

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

@@ -71,10 +71,7 @@ public void with(List<WithContext> withContexts) {
       var entityMetamodel = withContext.entityMetamodel();
       var setOperationContext = withContext.setOperationContext();
       // cte name
-      buf.appendSql(
-          entityMetamodel
-              .asType()
-              .getQualifiedTableName(config.getNaming()::apply, config.getDialect()::applyQuote));
+      buf.appendSql(getQualifiedTableName(entityMetamodel));
       // cte column list
       buf.appendSql("(");
       for (PropertyMetamodel<?> propertyMetamodel : entityMetamodel.allPropertyMetamodels()) {
@@ -166,15 +163,18 @@ private List<PropertyMetamodel<?>> wrapAliasExpression(
   }
 
   public void table(EntityMetamodel<?> entityMetamodel) {
-    EntityType<?> entityType = entityMetamodel.asType();
-    buf.appendSql(
-        entityType.getQualifiedTableName(
-            config.getNaming()::apply, config.getDialect()::applyQuote));
+    String table = getQualifiedTableName(entityMetamodel);
+    buf.appendSql(table);
     buf.appendSql(" ");
     String alias = getAlias(entityMetamodel);
     buf.appendSql(alias);
   }
 
+  public void tableOnly(EntityMetamodel<?> entityMetamodel) {
+    String table = getQualifiedTableName(entityMetamodel);
+    buf.appendSql(table);
+  }
+
   public void alias(EntityMetamodel<?> entityMetamodel) {
     String alias = getAlias(entityMetamodel);
     buf.appendSql(alias);
@@ -239,6 +239,12 @@ public void visitCriterion(int index, Criterion criterion) {
     criterion.accept(new CriterionVisitor(index));
   }
 
+  private String getQualifiedTableName(EntityMetamodel<?> entityMetamodel) {
+    return entityMetamodel
+        .asType()
+        .getQualifiedTableName(config.getNaming()::apply, config.getDialect()::applyQuote);
+  }
+
   private class OperandVisitor implements Operand.Visitor<Void> {
     @Override
     public Void visit(Operand.Param param) {
@@ -496,7 +502,7 @@ public void inSingleSubQuery(Operand.Prop left, SelectContext right, boolean not
         buf.appendSql(" not");
       }
       buf.appendSql(" in (");
-      AliasManager child = new AliasManager(right, aliasManager);
+      AliasManager child = AliasManager.createChild(config, right, aliasManager);
       SelectBuilder builder = new SelectBuilder(config, right, commenter, buf, child);
       builder.interpret();
       buf.appendSql(")");
@@ -542,7 +548,7 @@ private void inPairSubQuery(
         buf.appendSql(" not");
       }
       buf.appendSql(" in (");
-      AliasManager child = new AliasManager(right, aliasManager);
+      AliasManager child = AliasManager.createChild(config, right, aliasManager);
       SelectBuilder builder = new SelectBuilder(config, right, commenter, buf, child);
       builder.interpret();
       buf.appendSql(")");
@@ -594,7 +600,7 @@ private void inTripleSubQuery(
         buf.appendSql(" not");
       }
       buf.appendSql(" in (");
-      AliasManager child = new AliasManager(right, aliasManager);
+      AliasManager child = AliasManager.createChild(config, right, aliasManager);
       SelectBuilder builder = new SelectBuilder(config, right, commenter, buf, child);
       builder.interpret();
       buf.appendSql(")");
@@ -605,7 +611,7 @@ public void exists(SelectContext context, boolean not) {
         buf.appendSql("not ");
       }
       buf.appendSql("exists (");
-      AliasManager child = new AliasManager(context, aliasManager);
+      AliasManager child = AliasManager.createChild(config, context, aliasManager);
       SelectBuilder builder = new SelectBuilder(config, context, commenter, buf, child);
       builder.interpret();
       buf.appendSql(")");
@@ -696,6 +702,9 @@ protected Optional<String> getAlias(PropertyMetamodel<?> propertyMetamodel) {
       if (alias == null) {
         throw new DomaException(Message.DOMA6004, propertyMetamodel.getName());
       }
+      if (alias.isEmpty()) {
+        return Optional.empty();
+      }
       return Optional.of(alias);
     }
 
@@ -842,7 +851,7 @@ public void visit(CaseExpression<?> expression) {
     @Override
     public void visit(SelectExpression<?> expression) {
       buf.appendSql("(");
-      AliasManager child = new AliasManager(expression.context, aliasManager);
+      AliasManager child = AliasManager.createChild(config, expression.context, aliasManager);
       SelectBuilder builder = new SelectBuilder(config, expression.context, commenter, buf, child);
       builder.interpret();
       buf.appendSql(")");

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

@@ -7,9 +7,11 @@
 import org.seasar.doma.jdbc.PreparedSql;
 import org.seasar.doma.jdbc.SqlKind;
 import org.seasar.doma.jdbc.SqlLogType;
+import org.seasar.doma.jdbc.criteria.context.Context;
 import org.seasar.doma.jdbc.criteria.context.Criterion;
 import org.seasar.doma.jdbc.criteria.context.DeleteContext;
 import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
+import org.seasar.doma.jdbc.dialect.Dialect;
 
 public class DeleteBuilder {
   private final Config config;
@@ -28,7 +30,7 @@ public DeleteBuilder(
         context,
         commenter,
         new PreparedSqlBuilder(config, SqlKind.DELETE, sqlLogType),
-        new AliasManager(context));
+        createAliasManager(config, context));
   }
 
   public DeleteBuilder(
@@ -46,14 +48,29 @@ public DeleteBuilder(
     support = new BuilderSupport(config, commenter, buf, aliasManager);
   }
 
+  private static AliasManager createAliasManager(Config config, Context context) {
+    Objects.requireNonNull(config);
+    Objects.requireNonNull(context);
+    Dialect dialect = config.getDialect();
+    if (dialect.supportsAliasInDeleteClause() || dialect.supportsAliasInDeleteStatement()) {
+      return AliasManager.create(config, context);
+    } else {
+      return AliasManager.createEmpty(config, context);
+    }
+  }
+
   public PreparedSql build() {
     buf.appendSql("delete");
     if (config.getDialect().supportsAliasInDeleteClause()) {
       buf.appendSql(" ");
       alias(context.entityMetamodel);
     }
     buf.appendSql(" from ");
-    table(context.entityMetamodel);
+    tableOnly(context.entityMetamodel);
+    if (config.getDialect().supportsAliasInDeleteStatement()) {
+      buf.appendSql(" ");
+      alias(context.entityMetamodel);
+    }
     if (!context.where.isEmpty()) {
       buf.appendSql(" where ");
       int index = 0;
@@ -70,8 +87,8 @@ private void alias(EntityMetamodel<?> entityMetamodel) {
     support.alias(entityMetamodel);
   }
 
-  private void table(EntityMetamodel<?> entityMetamodel) {
-    support.table(entityMetamodel);
+  private void tableOnly(EntityMetamodel<?> entityMetamodel) {
+    support.tableOnly(entityMetamodel);
   }
 
   private void visitCriterion(int index, Criterion criterion) {

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

@@ -0,0 +1,65 @@
+package org.seasar.doma.jdbc.criteria.query;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.function.Function;
+import org.seasar.doma.jdbc.Config;
+import org.seasar.doma.jdbc.criteria.context.Context;
+import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
+
+/**
+ * The {@code EmptyAliasManager} class is a specialized implementation of {@code AliasManager} where
+ * all aliases for entity and property metamodels are resolved to empty strings by default.
+ *
+ * <p>This class can be used when aliasing is not required, providing a simple and minimal alias
+ * management strategy.
+ *
+ * <p>It provides functionality to manage alias mappings in a way that clears existing mappings and
+ * replaces them with the provided or default alias resolution logic.
+ */
+class EmptyAliasManager extends AliasManager {
+
+  private final Config config;
+
+  EmptyAliasManager(Config config, Context context) {
+    this(config, context, (__) -> "");
+  }
+
+  @SuppressWarnings("deprecation")
+  private EmptyAliasManager(
+      Config config, Context context, Function<EntityMetamodel<?>, String> aliasResolver) {
+    super(context);
+    this.config = Objects.requireNonNull(config);
+    replaceAliases(context.getEntityMetamodels(), entityAliasMap, propertyAliasMap, aliasResolver);
+  }
+
+  private static void replaceAliases(
+      List<EntityMetamodel<?>> entityMetamodels,
+      Map<EntityMetamodel<?>, String> entityAliasMap,
+      Map<PropertyMetamodel<?>, String> propertyAliasMap,
+      Function<EntityMetamodel<?>, String> aliasResolver) {
+    entityAliasMap.clear();
+    propertyAliasMap.clear();
+    for (EntityMetamodel<?> entityMetamodel : entityMetamodels) {
+      String alias = aliasResolver.apply(entityMetamodel);
+      entityAliasMap.put(entityMetamodel, alias);
+      for (PropertyMetamodel<?> propertyMetamodel : entityMetamodel.allPropertyMetamodels()) {
+        propertyAliasMap.put(propertyMetamodel, alias);
+      }
+    }
+  }
+
+  @Override
+  protected AliasManager asParent() {
+    Function<EntityMetamodel<?>, String> aliasResolver = (m) -> getQualifiedTableName(config, m);
+    return new EmptyAliasManager(config, context, aliasResolver);
+  }
+
+  private static String getQualifiedTableName(Config config, EntityMetamodel<?> entityMetamodel) {
+    return entityMetamodel
+        .asType()
+        .getQualifiedTableName(config.getNaming()::apply, config.getDialect()::applyQuote);
+  }
+}

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

@@ -89,7 +89,7 @@ private void select() {
             });
     buf.cutBackSql(2);
     buf.appendSql(") ");
-    AliasManager aliasManager = new AliasManager(context.selectContext);
+    AliasManager aliasManager = AliasManager.create(config, context.selectContext);
     SelectBuilder builder =
         new SelectBuilder(config, context.selectContext, Function.identity(), buf, aliasManager);
     builder.interpret();

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

@@ -41,7 +41,7 @@ public SelectBuilder(
         context,
         commenter,
         new PreparedSqlBuilder(config, SqlKind.SELECT, sqlLogType),
-        new AliasManager(context));
+        AliasManager.create(config, context));
   }
 
   public SelectBuilder(