Support the Metamodel annotation

Author: nakamura-to

README.md

@@ -150,6 +150,7 @@ domaCodeGen {
 | showDbComment | whether to show database comments or not |  | `true` |
 | useAccessor | whether to use accessors or not |  | `true` |
 | useListener | whether to use listeners or not |  | `true` |
+| useMetamodel | whether to use metamodels or not |  | `true` |
 | originalStatesPropertyName | property to be annotated with `@OriginalStates` |  | |
 | entityPropertyClassNamesFile | file used to resolve entity property classes |  | |
 | prefix | prefix for entity classes |  | |

codegen-test/build.gradle

@@ -2,7 +2,7 @@ import org.h2.Driver
 import org.seasar.doma.gradle.codegen.jdbc.SimpleDataSource
 
 buildscript {
-    ext.domaVersion = '2.28.0'
+    ext.domaVersion = '2.36.0'
     ext.h2Version= '1.4.200'
     repositories {
         mavenCentral()
@@ -37,8 +37,8 @@ repositories {
 }
 
 dependencies {
-    implementation "org.seasar.doma:doma:$domaVersion"
-    annotationProcessor "org.seasar.doma:doma:$domaVersion"
+    implementation "org.seasar.doma:doma-core:$domaVersion"
+    annotationProcessor "org.seasar.doma:doma-processor:$domaVersion"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.1'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.1'
     testRuntimeOnly "com.h2database:h2:$h2Version"

codegen/build.gradle

@@ -58,7 +58,7 @@ repositories {
 
 dependencies {
     implementation 'org.freemarker:freemarker:2.3.30'
-    testImplementation "org.seasar.doma:doma:2.28.0"
+    testImplementation "org.seasar.doma:doma-core:2.36.0"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.1'
     testImplementation 'org.junit.jupiter:junit-jupiter-params:5.6.1'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.1'

codegen/gradle.properties

@@ -1,2 +1,2 @@
 group=org.seasar.doma
-version=0.0.2
+version=0.0.3-SNAPSHOT

codegen/src/main/java/org/seasar/doma/gradle/codegen/GlobalFactory.java

@@ -76,7 +76,8 @@ public EntityDescFactory createEntityDescFactory(
       boolean showTableName,
       boolean showDbComment,
       boolean useAccessor,
-      boolean useListener) {
+      boolean useListener,
+      boolean useMetamodel) {
     return new EntityDescFactory(
         packageName,
         superclass,
@@ -88,7 +89,8 @@ public EntityDescFactory createEntityDescFactory(
         showTableName,
         showDbComment,
         useAccessor,
-        useListener);
+        useListener,
+        useMetamodel);
   }
 
   public EntityListenerDescFactory createEntityListenerDescFactory(

codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/ClassConstants.java

@@ -13,6 +13,8 @@ public enum ClassConstants {
 
   Entity("org.seasar.doma", "Entity"),
 
+  Metamodel("org.seasar.doma", "Metamodel"),
+
   Table("org.seasar.doma", "Table"),
 
   Id("org.seasar.doma", "Id"),

codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/EntityDesc.java

@@ -38,6 +38,8 @@ public class EntityDesc extends ClassDesc {
 
   protected boolean useListener;
 
+  protected boolean useMetamodel;
+
   protected boolean showDbComment;
 
   protected String templateName;
@@ -181,6 +183,14 @@ public void setUseListener(boolean useListener) {
     this.useListener = useListener;
   }
 
+  public boolean isUseMetamodel() {
+    return useMetamodel;
+  }
+
+  public void setUseMetamodel(boolean useMetamodel) {
+    this.useMetamodel = useMetamodel;
+  }
+
   public boolean isShowDbComment() {
     return showDbComment;
   }

codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/EntityDescFactory.java

@@ -30,6 +30,8 @@ public class EntityDescFactory {
 
   protected final boolean useListener;
 
+  protected final boolean useMetamodel;
+
   protected final Class<?> superclass;
 
   protected final EntityPropertyDescMerger entityPropertyDescMerger;
@@ -47,7 +49,8 @@ public EntityDescFactory(
       boolean showTableName,
       boolean showDbComment,
       boolean useAccessor,
-      boolean useListener) {
+      boolean useListener,
+      boolean useMetamodel) {
     if (entityPropertyDescFactory == null) {
       throw new CodeGenNullPointerException("entityPropertyDescFactory");
     }
@@ -65,6 +68,7 @@ public EntityDescFactory(
     this.showDbComment = showDbComment;
     this.useAccessor = useAccessor;
     this.useListener = useListener;
+    this.useMetamodel = useMetamodel;
     this.entityPropertyDescMerger = new EntityPropertyDescMerger(superclass);
   }
 
@@ -108,6 +112,7 @@ public EntityDesc createEntityDesc(
     entityDesc.setShowDbComment(true);
     entityDesc.setUseAccessor(useAccessor);
     entityDesc.setUseListener(useListener);
+    entityDesc.setUseMetamodel(useMetamodel);
     entityDesc.setTemplateName(Constants.ENTITY_TEMPLATE);
     handleShowTableName(entityDesc, tableMeta);
     handleEntityPropertyDesc(entityDesc, tableMeta);
@@ -145,6 +150,9 @@ protected void handleEntityPropertyDesc(EntityDesc entityDesc, TableMeta tableMe
 
   protected void handleImportName(EntityDesc entityDesc, TableMeta tableMeta) {
     classDescSupport.addImportName(entityDesc, ClassConstants.Entity);
+    if (entityDesc.isUseMetamodel()) {
+      classDescSupport.addImportName(entityDesc, ClassConstants.Metamodel);
+    }
     if (entityDesc.getCatalogName() != null
         || entityDesc.getSchemaName() != null
         || entityDesc.getTableName() != null) {

codegen/src/main/java/org/seasar/doma/gradle/codegen/extension/EntityConfig.java

@@ -43,6 +43,8 @@ public class EntityConfig {
 
   protected Property<Boolean> useListener;
 
+  protected Property<Boolean> useMetamodel;
+
   protected Property<String> originalStatesPropertyName;
 
   protected RegularFileProperty entityPropertyClassNamesFile;
@@ -69,6 +71,7 @@ public EntityConfig(ObjectFactory objects) {
     showDbComment = objects.property(Boolean.class);
     useAccessor = objects.property(Boolean.class);
     useListener = objects.property(Boolean.class);
+    useMetamodel = objects.property(Boolean.class);
     originalStatesPropertyName = objects.property(String.class);
     entityPropertyClassNamesFile = objects.fileProperty();
     prefix = objects.property(String.class);
@@ -84,6 +87,7 @@ public EntityConfig(ObjectFactory objects) {
     showDbComment.set(true);
     useAccessor.set(true);
     useListener.set(true);
+    useMetamodel.set(true);
   }
 
   @Internal
@@ -230,6 +234,15 @@ public void setUseListener(boolean useListener) {
     this.useListener.set(useListener);
   }
 
+  @Internal
+  public Property<Boolean> getUseMetamodel() {
+    return useMetamodel;
+  }
+
+  public void setUseMetamodel(boolean useMetamodel) {
+    this.useMetamodel.set(useMetamodel);
+  }
+
   @Internal
   public Property<String> getOriginalStatesPropertyName() {
     return originalStatesPropertyName;

codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenDtoTask.java

@@ -206,7 +206,8 @@ private EntityDescFactory createEntityDescFactory(
             entityConfig.getShowTableName().get(),
             entityConfig.getShowDbComment().get(),
             entityConfig.getUseAccessor().get(),
-            false);
+            entityConfig.getUseListener().get(),
+            entityConfig.getUseMetamodel().get());
   }
 
   protected void generateDto(EntityDesc entityDesc) {