Introduce the Metamodel annotation

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/Entity.java

@@ -111,4 +111,13 @@
    * @return whether the entity class is immutable
    */
   boolean immutable() default false;
+
+  /**
+   * The metamodel information for the Criteria API.
+   *
+   * <p>If specified, the metamodel class is generated by the annotation processor.
+   *
+   * @return the metamodel
+   */
+  Metamodel metamodel() default @Metamodel();
 }

doma-core/src/main/java/org/seasar/doma/Metamodel.java

@@ -0,0 +1,34 @@
+package org.seasar.doma;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Indicates a metamodel class.
+ *
+ * <p>For example, the name of the metamodel is "MyEmployeeMetamodel" when you specify the prefix
+ * and the suffix as follows:
+ *
+ * <pre>
+ * &#064;Entity(metamodel = &#064;Metamodel(prefix = "My", suffix="Metamodel")
+ * public class Employee {
+ *     ...
+ * }
+ * </pre>
+ *
+ * <p>If both the {@code prefix} and the {@code suffix} are empty, the values of the following
+ * annotation processing options are used:
+ *
+ * <ul>
+ *   <li>doma.metamodel.prefix
+ *   <li>doma.metamodel.suffix
+ * </ul>
+ */
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Metamodel {
+  /** @return the prefix for the metamodel class */
+  String prefix() default "";
+
+  /** @return the suffix for the metamodel class */
+  String suffix() default "";
+}

doma-core/src/main/java/org/seasar/doma/internal/ClassNames.java

@@ -43,16 +43,10 @@ public static ClassName newExternalDomainTypeClassName(CharSequence externalDoma
     return new ExternalDomainClassNameBuilder(externalDomainClassName).build();
   }
 
-  public static ClassName newEntityDefClassNameBuilder(
-      CharSequence entityClassName, String criteriaPrefix, String criteriaSuffix) {
-    assertNotNull(entityClassName, criteriaPrefix, criteriaSuffix);
-    return new DefClassNameBuilder(entityClassName, criteriaPrefix, criteriaSuffix).build();
-  }
-
-  public static ClassName newEmbeddableDefClassNameBuilder(
-      CharSequence entityClassName, String criteriaPrefix, String criteriaSuffix) {
-    assertNotNull(entityClassName, criteriaPrefix, criteriaSuffix);
-    return new DefClassNameBuilder(entityClassName, criteriaPrefix, criteriaSuffix).build();
+  public static ClassName newEntityMetamodelClassNameBuilder(
+      CharSequence entityClassName, String metamodelPrefix, String metamodelSuffix) {
+    assertNotNull(entityClassName, metamodelPrefix, metamodelSuffix);
+    return new MetamodelClassNameBuilder(entityClassName, metamodelPrefix, metamodelSuffix).build();
   }
 
   private static class ClassNameBuilder {
@@ -101,11 +95,11 @@ protected String prefix() {
     }
   }
 
-  private static class DefClassNameBuilder extends ClassNameBuilder {
+  private static class MetamodelClassNameBuilder extends ClassNameBuilder {
     private final String criteriaPrefix;
     private final String criteriaSuffix;
 
-    public DefClassNameBuilder(
+    public MetamodelClassNameBuilder(
         CharSequence binaryName, String criteriaPrefix, String criteriaSuffix) {
       super(binaryName);
       this.criteriaPrefix = criteriaPrefix;

doma-core/src/main/java/org/seasar/doma/internal/EmbeddableDesc.java

@@ -1,31 +1,35 @@
 package org.seasar.doma.jdbc.criteria;
 
 import org.seasar.doma.jdbc.criteria.declaration.AggregateFunction;
-import org.seasar.doma.jdbc.criteria.def.PropertyDef;
+import org.seasar.doma.jdbc.criteria.metamodel.PropertyMetamodel;
 
 public final class AggregateFunctions {
 
-  public static <PROPERTY> AggregateFunction.Avg<PROPERTY> avg(PropertyDef<PROPERTY> propertyDef) {
-    return new AggregateFunction.Avg<>(propertyDef);
+  public static <PROPERTY> AggregateFunction.Avg<PROPERTY> avg(
+      PropertyMetamodel<PROPERTY> propertyMetamodel) {
+    return new AggregateFunction.Avg<>(propertyMetamodel);
   }
 
   public static AggregateFunction.Count count() {
     return new AggregateFunction.Count(AggregateFunction.Asterisk);
   }
 
-  public static AggregateFunction.Count count(PropertyDef<?> propertyDef) {
-    return new AggregateFunction.Count(propertyDef);
+  public static AggregateFunction.Count count(PropertyMetamodel<?> propertyMetamodel) {
+    return new AggregateFunction.Count(propertyMetamodel);
   }
 
-  public static <PROPERTY> AggregateFunction.Max<PROPERTY> max(PropertyDef<PROPERTY> propertyDef) {
-    return new AggregateFunction.Max<>(propertyDef);
+  public static <PROPERTY> AggregateFunction.Max<PROPERTY> max(
+      PropertyMetamodel<PROPERTY> propertyMetamodel) {
+    return new AggregateFunction.Max<>(propertyMetamodel);
   }
 
-  public static <PROPERTY> AggregateFunction.Min<PROPERTY> min(PropertyDef<PROPERTY> propertyDef) {
-    return new AggregateFunction.Min<>(propertyDef);
+  public static <PROPERTY> AggregateFunction.Min<PROPERTY> min(
+      PropertyMetamodel<PROPERTY> propertyMetamodel) {
+    return new AggregateFunction.Min<>(propertyMetamodel);
   }
 
-  public static <PROPERTY> AggregateFunction.Sum<PROPERTY> sum(PropertyDef<PROPERTY> propertyDef) {
-    return new AggregateFunction.Sum<>(propertyDef);
+  public static <PROPERTY> AggregateFunction.Sum<PROPERTY> sum(
+      PropertyMetamodel<PROPERTY> propertyMetamodel) {
+    return new AggregateFunction.Sum<>(propertyMetamodel);
   }
 }

doma-core/src/main/java/org/seasar/doma/internal/EntityDesc.java

@@ -10,7 +10,7 @@
 import org.seasar.doma.jdbc.criteria.context.SelectSettings;
 import org.seasar.doma.jdbc.criteria.context.UpdateSettings;
 import org.seasar.doma.jdbc.criteria.declaration.SelectFromDeclaration;
-import org.seasar.doma.jdbc.criteria.def.EntityDef;
+import org.seasar.doma.jdbc.criteria.metamodel.EntityMetamodel;
 import org.seasar.doma.jdbc.criteria.statement.EntityqlBatchDeleteStatement;
 import org.seasar.doma.jdbc.criteria.statement.EntityqlBatchInsertStatement;
 import org.seasar.doma.jdbc.criteria.statement.EntityqlBatchUpdateStatement;
@@ -28,123 +28,129 @@ public Entityql(Config config) {
     this.config = Objects.requireNonNull(config);
   }
 
-  public <ENTITY> EntityqlSelectStatement<ENTITY> from(EntityDef<ENTITY> entityDef) {
-    Objects.requireNonNull(entityDef);
-    return from(entityDef, options -> {});
+  public <ENTITY> EntityqlSelectStatement<ENTITY> from(EntityMetamodel<ENTITY> entityMetamodel) {
+    Objects.requireNonNull(entityMetamodel);
+    return from(entityMetamodel, options -> {});
   }
 
   public <ENTITY> EntityqlSelectStatement<ENTITY> from(
-      EntityDef<ENTITY> entityDef, Consumer<SelectSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel, Consumer<SelectSettings> settingsConsumer) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(settingsConsumer);
-    SelectContext context = new SelectContext(entityDef);
+    SelectContext context = new SelectContext(entityMetamodel);
     settingsConsumer.accept(context.getSettings());
     SelectFromDeclaration declaration = new SelectFromDeclaration(context);
     return new EntityqlSelectStatement<>(config, declaration);
   }
 
-  public <ENTITY> Statement<ENTITY> update(EntityDef<ENTITY> entityDef, ENTITY entity) {
-    Objects.requireNonNull(entityDef);
+  public <ENTITY> Statement<ENTITY> update(EntityMetamodel<ENTITY> entityMetamodel, ENTITY entity) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
-    return update(entityDef, entity, options -> {});
+    return update(entityMetamodel, entity, options -> {});
   }
 
   public <ENTITY> Statement<ENTITY> update(
-      EntityDef<ENTITY> entityDef, ENTITY entity, Consumer<UpdateSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel,
+      ENTITY entity,
+      Consumer<UpdateSettings> settingsConsumer) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
     Objects.requireNonNull(settingsConsumer);
     UpdateSettings settings = new UpdateSettings();
     settingsConsumer.accept(settings);
-    return new EntityqlUpdateStatement<>(config, entityDef, entity, settings);
+    return new EntityqlUpdateStatement<>(config, entityMetamodel, entity, settings);
   }
 
-  public <ENTITY> Statement<ENTITY> delete(EntityDef<ENTITY> entityDef, ENTITY entity) {
-    Objects.requireNonNull(entityDef);
+  public <ENTITY> Statement<ENTITY> delete(EntityMetamodel<ENTITY> entityMetamodel, ENTITY entity) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
-    return delete(entityDef, entity, options -> {});
+    return delete(entityMetamodel, entity, options -> {});
   }
 
   public <ENTITY> Statement<ENTITY> delete(
-      EntityDef<ENTITY> entityDef, ENTITY entity, Consumer<DeleteSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel,
+      ENTITY entity,
+      Consumer<DeleteSettings> settingsConsumer) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
     Objects.requireNonNull(settingsConsumer);
     DeleteSettings settings = new DeleteSettings();
     settingsConsumer.accept(settings);
-    return new EntityqlDeleteStatement<>(config, entityDef, entity, settings);
+    return new EntityqlDeleteStatement<>(config, entityMetamodel, entity, settings);
   }
 
-  public <ENTITY> Statement<ENTITY> insert(EntityDef<ENTITY> entityDef, ENTITY entity) {
-    Objects.requireNonNull(entityDef);
+  public <ENTITY> Statement<ENTITY> insert(EntityMetamodel<ENTITY> entityMetamodel, ENTITY entity) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
-    return insert(entityDef, entity, options -> {});
+    return insert(entityMetamodel, entity, options -> {});
   }
 
   public <ENTITY> Statement<ENTITY> insert(
-      EntityDef<ENTITY> entityDef, ENTITY entity, Consumer<InsertSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel,
+      ENTITY entity,
+      Consumer<InsertSettings> settingsConsumer) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entity);
     Objects.requireNonNull(settingsConsumer);
     InsertSettings settings = new InsertSettings();
     settingsConsumer.accept(settings);
-    return new EntityqlInsertStatement<>(config, entityDef, entity, settings);
+    return new EntityqlInsertStatement<>(config, entityMetamodel, entity, settings);
   }
 
   public <ENTITY> Statement<List<ENTITY>> update(
-      EntityDef<ENTITY> entityDef, List<ENTITY> entities) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel, List<ENTITY> entities) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
-    return update(entityDef, entities, options -> {});
+    return update(entityMetamodel, entities, options -> {});
   }
 
   public <ENTITY> Statement<List<ENTITY>> update(
-      EntityDef<ENTITY> entityDef,
+      EntityMetamodel<ENTITY> entityMetamodel,
       List<ENTITY> entities,
       Consumer<UpdateSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
     Objects.requireNonNull(settingsConsumer);
     UpdateSettings settings = new UpdateSettings();
     settingsConsumer.accept(settings);
-    return new EntityqlBatchUpdateStatement<>(config, entityDef, entities, settings);
+    return new EntityqlBatchUpdateStatement<>(config, entityMetamodel, entities, settings);
   }
 
   public <ENTITY> Statement<List<ENTITY>> delete(
-      EntityDef<ENTITY> entityDef, List<ENTITY> entities) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel, List<ENTITY> entities) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
-    return delete(entityDef, entities, options -> {});
+    return delete(entityMetamodel, entities, options -> {});
   }
 
   public <ENTITY> Statement<List<ENTITY>> delete(
-      EntityDef<ENTITY> entityDef,
+      EntityMetamodel<ENTITY> entityMetamodel,
       List<ENTITY> entities,
       Consumer<DeleteSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
     Objects.requireNonNull(settingsConsumer);
     DeleteSettings settings = new DeleteSettings();
     settingsConsumer.accept(settings);
-    return new EntityqlBatchDeleteStatement<>(config, entityDef, entities, settings);
+    return new EntityqlBatchDeleteStatement<>(config, entityMetamodel, entities, settings);
   }
 
   public <ENTITY> Statement<List<ENTITY>> insert(
-      EntityDef<ENTITY> entityDef, List<ENTITY> entities) {
-    Objects.requireNonNull(entityDef);
+      EntityMetamodel<ENTITY> entityMetamodel, List<ENTITY> entities) {
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
-    return insert(entityDef, entities, options -> {});
+    return insert(entityMetamodel, entities, options -> {});
   }
 
   public <ENTITY> Statement<List<ENTITY>> insert(
-      EntityDef<ENTITY> entityDef,
+      EntityMetamodel<ENTITY> entityMetamodel,
       List<ENTITY> entities,
       Consumer<InsertSettings> settingsConsumer) {
-    Objects.requireNonNull(entityDef);
+    Objects.requireNonNull(entityMetamodel);
     Objects.requireNonNull(entities);
     Objects.requireNonNull(settingsConsumer);
     InsertSettings settings = new InsertSettings();
     settingsConsumer.accept(settings);
-    return new EntityqlBatchInsertStatement<>(config, entityDef, entities, settings);
+    return new EntityqlBatchInsertStatement<>(config, entityMetamodel, entities, settings);
   }
 }