Support overriding identity column values during inserts (#1301)

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/Dialect.java

@@ -90,6 +90,19 @@ public interface Dialect {
    */
   boolean includesIdentityColumn();
 
+  /**
+   * Determines if the identity column is included based on the provided identifier value.
+   *
+   * <p>The type of {@code idValue} must be one of the basic types. It must never be a domain class
+   * or an Optional type that wraps a basic type.
+   *
+   * @param idValue an identity value; may be null
+   * @return true if the identity column is included, false otherwise
+   */
+  default boolean includesIdentityColumn(Object idValue) {
+    return includesIdentityColumn();
+  }
+
   /**
    * Whether this object supports the IDENTITY column.
    *

doma-core/src/main/java/org/seasar/doma/jdbc/entity/GeneratedIdPropertyType.java

@@ -84,10 +84,15 @@ protected boolean isGenerationTypeSupported(GenerationType generationType, Diale
     }
   }
 
+  @Deprecated
   public boolean isIncluded(IdGenerationConfig config) {
     return idGenerator.includesIdentityColumn(config);
   }
 
+  public boolean isIncluded(IdGenerationConfig config, Object idValue) {
+    return idGenerator.includesIdentityColumn(config, idValue);
+  }
+
   public boolean isBatchSupported(IdGenerationConfig config) {
     return idGenerator.supportsBatch(config);
   }

doma-core/src/main/java/org/seasar/doma/jdbc/id/AbstractPreGenerateIdGenerator.java

@@ -60,11 +60,17 @@ public boolean supportsAutoGeneratedKeys(IdGenerationConfig config) {
     return false;
   }
 
+  @SuppressWarnings("deprecation")
   @Override
   public boolean includesIdentityColumn(IdGenerationConfig config) {
     return true;
   }
 
+  @Override
+  public boolean includesIdentityColumn(IdGenerationConfig config, Object idValue) {
+    return true;
+  }
+
   @Override
   public Long generatePreInsert(IdGenerationConfig config) {
     IdContext idContext = getIdContext(config);

doma-core/src/main/java/org/seasar/doma/jdbc/id/BuiltinIdentityIdGenerator.java

@@ -37,11 +37,17 @@ public boolean supportsBatch(IdGenerationConfig config) {
     return config.getDialect().supportsBatchExecutionReturningGeneratedValues();
   }
 
+  @SuppressWarnings("deprecation")
   @Override
   public boolean includesIdentityColumn(IdGenerationConfig config) {
     return config.getDialect().includesIdentityColumn();
   }
 
+  @Override
+  public boolean includesIdentityColumn(IdGenerationConfig config, Object idValue) {
+    return config.getDialect().includesIdentityColumn(idValue);
+  }
+
   @Override
   public boolean supportsAutoGeneratedKeys(IdGenerationConfig config) {
     return config.getDialect().supportsAutoGeneratedKeys();

doma-core/src/main/java/org/seasar/doma/jdbc/id/IdGenerator.java

@@ -55,8 +55,25 @@ public interface IdGenerator {
    * @param config the configuration
    * @return {@code true} if supported
    */
+  @Deprecated
   boolean includesIdentityColumn(IdGenerationConfig config);
 
+  /**
+   * Determines whether the identity column is included in the SQL INSERT statements based on the
+   * given configuration and identity value.
+   *
+   * <p>The type of {@code idValue} must be one of the basic types. It must never be a domain class
+   * or an Optional type that wraps a basic type.
+   *
+   * @param config the configuration for identity generation
+   * @param idValue an identity value; may be null
+   * @return {@code true} if the identity column is included in the SQL INSERT statements, otherwise
+   *     {@code false}
+   */
+  default boolean includesIdentityColumn(IdGenerationConfig config, Object idValue) {
+    return includesIdentityColumn(config);
+  }
+
   /**
    * Generates the identity value before an insert.
    *

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

@@ -139,13 +139,14 @@ protected void prepareTargetPropertyTypes() {
         continue;
       }
       if (propertyType.isId()) {
+        Property<ENTITY, ?> property = propertyType.createProperty();
+        property.load(currentEntity);
         if (propertyType != generatedIdPropertyType
-            || generatedIdPropertyType.isIncluded(idGenerationConfig)) {
+            || generatedIdPropertyType.isIncluded(
+                idGenerationConfig, property.getWrapper().get())) {
           targetPropertyTypes.add(propertyType);
         }
         if (generatedIdPropertyType == null) {
-          Property<ENTITY, ?> property = propertyType.createProperty();
-          property.load(currentEntity);
           if (property.getWrapper().get() == null) {
             throw new JdbcException(Message.DOMA2020, entityType.getName(), propertyType.getName());
           }

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

@@ -102,7 +102,8 @@ protected void prepareTargetPropertyType() {
       property.load(entity);
       if (propertyType.isId()) {
         if (propertyType != generatedIdPropertyType
-            || generatedIdPropertyType.isIncluded(idGenerationConfig)) {
+            || generatedIdPropertyType.isIncluded(
+                idGenerationConfig, property.getWrapper().get())) {
           targetPropertyTypes.add(propertyType);
         }
         if (generatedIdPropertyType == null && property.getWrapper().get() == null) {

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

@@ -124,7 +124,8 @@ protected void prepareTargetPropertyType() {
       property.load(entity);
       if (propertyType.isId()) {
         if (propertyType != generatedIdPropertyType
-            || generatedIdPropertyType.isIncluded(idGenerationConfig)) {
+            || generatedIdPropertyType.isIncluded(
+                idGenerationConfig, property.getWrapper().get())) {
           targetPropertyTypes.add(propertyType);
         }
         if (generatedIdPropertyType == null && property.getWrapper().get() == null) {