Refactor and simplify association linking logic

Author: nakamura-to

LICENSE.txt

@@ -43,7 +43,7 @@
       editorial revisions, annotations, elaborations, or other modifications
       represent, as a whole, an original work of authorship. For the purposes
       of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
+      separable from, or merely linkMeta (or bind by name) to the interfaces of,
       the Work and Derivative Works thereof.
 
       "Contribution" shall mean any work of authorship, including

doma-processor/src/main/java/org/seasar/doma/internal/apt/cttype/EntityCtType.java

@@ -53,6 +53,14 @@ public <R, P, TH extends Throwable> R accept(CtTypeVisitor<R, P, TH> visitor, P
     return visitor.visitEntityCtType(this, p);
   }
 
+  /**
+   * Resolves an {@code EntityCtType} from the given {@code CtType}. This method traverses the type
+   * hierarchy of the provided {@code CtType} and identifies if it corresponds to an {@code
+   * EntityCtType}. It also handles nested and optional types.
+   *
+   * @param ctType the {@code CtType} instance to resolve into an {@code EntityCtType}.
+   * @return the resolved {@code EntityCtType} if found; otherwise, null.
+   */
   public static EntityCtType resolveEntityCtType(CtType ctType) {
     class EntityCtTypeVisitor extends SimpleCtTypeVisitor<EntityCtType, Void, RuntimeException> {
       @Override

doma-processor/src/main/java/org/seasar/doma/internal/apt/generator/AggregateStrategyTypeGenerator.java

@@ -20,8 +20,8 @@
 import java.util.Iterator;
 import org.seasar.doma.internal.ClassName;
 import org.seasar.doma.internal.apt.Context;
-import org.seasar.doma.internal.apt.meta.entity.AggregateStrategyMeta;
-import org.seasar.doma.internal.apt.meta.entity.AssociationLinkerMeta;
+import org.seasar.doma.internal.apt.meta.aggregate.AggregateStrategyMeta;
+import org.seasar.doma.internal.apt.meta.aggregate.AssociationLinkerMeta;
 import org.seasar.doma.jdbc.aggregate.AbstractAggregateStrategyType;
 import org.seasar.doma.jdbc.aggregate.AssociationLinkerType;
 

doma-processor/src/main/java/org/seasar/doma/internal/apt/generator/DaoImplQueryMethodGenerator.java

@@ -45,9 +45,9 @@
 import org.seasar.doma.internal.apt.cttype.OptionalLongCtType;
 import org.seasar.doma.internal.apt.cttype.SimpleCtTypeVisitor;
 import org.seasar.doma.internal.apt.cttype.StreamCtType;
+import org.seasar.doma.internal.apt.meta.aggregate.AggregateStrategyMeta;
+import org.seasar.doma.internal.apt.meta.aggregate.AssociationLinkerMeta;
 import org.seasar.doma.internal.apt.meta.dao.DaoMeta;
-import org.seasar.doma.internal.apt.meta.entity.AggregateStrategyMeta;
-import org.seasar.doma.internal.apt.meta.entity.AssociationLinkerMeta;
 import org.seasar.doma.internal.apt.meta.parameter.BasicInOutParameterMeta;
 import org.seasar.doma.internal.apt.meta.parameter.BasicInParameterMeta;
 import org.seasar.doma.internal.apt.meta.parameter.BasicListParameterMeta;

doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/entity/AggregateStrategyMeta.java renamed to doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/aggregate/AggregateStrategyMeta.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.seasar.doma.internal.apt.meta.entity;
+package org.seasar.doma.internal.apt.meta.aggregate;
 
 import java.util.List;
 import java.util.Objects;

doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/entity/AggregateStrategyMetaFactory.java renamed to doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/aggregate/AggregateStrategyMetaFactory.java

@@ -13,13 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.seasar.doma.internal.apt.meta.entity;
+package org.seasar.doma.internal.apt.meta.aggregate;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Comparator;
 import java.util.HashSet;
-import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -78,11 +77,10 @@ public AggregateStrategyMeta createTypeElementMeta(TypeElement typeElement) {
     if (root == null) {
       throw new AptException(Message.DOMA4478, typeElement, new Object[] {});
     }
-    List<AssociationLinkerMeta> associationLinkerMetas =
-        findAssociationLinkerMetas(typeElement, root);
+    List<AssociationLinkerMeta> associationLinkerMetas = findAssociationLinkerMetas(typeElement);
     validateAllPropertyPaths(associationLinkerMetas);
     validateAllTableAliases(aggregateStrategyAnnot.getTableAliasValue(), associationLinkerMetas);
-    validateAssociationNavigation(root, associationLinkerMetas);
+    validateNavigation(root, associationLinkerMetas);
     return new AggregateStrategyMeta(
         root, aggregateStrategyAnnot.getTableAliasValue(), associationLinkerMetas);
   }
@@ -135,7 +133,7 @@ private void validateAllTableAliases(
     }
   }
 
-  private void validateAssociationNavigation(
+  private void validateNavigation(
       EntityCtType root, List<AssociationLinkerMeta> associationLinkerMetas) {
     for (AssociationLinkerMeta linkerMeta : associationLinkerMetas) {
       TypeMirror source = root.getType();
@@ -146,24 +144,23 @@ private void validateAssociationNavigation(
             resolveEntity(
                 source, segment, linkerMeta.filedElement(), linkerMeta.associationLinkerAnnot());
       }
-      BiFunctionMeta biFunctionMeta = linkerMeta.biFunctionMeta();
-      if (!ctx.getMoreTypes().isSameType(biFunctionMeta.source().getType(), source)) {
+      if (!ctx.getMoreTypes().isSameType(linkerMeta.source().getType(), source)) {
         throw new AptException(
             Message.DOMA4475,
             linkerMeta.filedElement(),
-            new Object[] {biFunctionMeta.source().getType(), source});
+            new Object[] {linkerMeta.source().getType(), source});
       }
-      if (!ctx.getMoreTypes().isSameType(biFunctionMeta.target().getType(), target)) {
+      if (!ctx.getMoreTypes().isSameType(linkerMeta.target().getType(), target)) {
         throw new AptException(
             Message.DOMA4476,
             linkerMeta.filedElement(),
-            new Object[] {biFunctionMeta.target().getType(), target});
+            new Object[] {linkerMeta.target().getType(), target});
       }
     }
   }
 
   private List<AssociationLinkerMeta> findAssociationLinkerMetas(
-      TypeElement aggregateStrategyElement, EntityCtType root) {
+      TypeElement aggregateStrategyElement) {
     List<AssociationLinkerMeta> associationLinkerMetas = new ArrayList<>();
 
     for (VariableElement fieldElement :
@@ -173,10 +170,9 @@ private List<AssociationLinkerMeta> findAssociationLinkerMetas(
         continue;
       }
       validateModifiers(fieldElement);
-      BiFunctionMeta biFunctionMeta = createBiFunctionMeta(fieldElement);
       AssociationLinkerMeta associationLinkerMeta =
           createAssociationLinkerMeta(
-              fieldElement, associationLinkerAnnot, biFunctionMeta, aggregateStrategyElement);
+              fieldElement, associationLinkerAnnot, aggregateStrategyElement);
       associationLinkerMetas.add(associationLinkerMeta);
     }
 
@@ -233,37 +229,6 @@ private void validateModifiers(VariableElement linkerElement) {
     }
   }
 
-  private BiFunctionMeta createBiFunctionMeta(VariableElement linkerElement) {
-    BiFunctionCtType ctType = ctx.getCtTypes().newBiFunctionCtType(linkerElement.asType());
-    if (ctType == null) {
-      throw new AptException(Message.DOMA4465, linkerElement, new Object[] {});
-    }
-    CtTypeVisitor<EntityCtType, String, RuntimeException> entityCtTypeVisitor =
-        new SimpleCtTypeVisitor<>() {
-          @Override
-          protected EntityCtType defaultAction(CtType ctType, String ordinalNumber)
-              throws RuntimeException {
-            throw new AptException(Message.DOMA4466, linkerElement, new Object[] {ordinalNumber});
-          }
-
-          @Override
-          public EntityCtType visitEntityCtType(EntityCtType ctType, String ordinalNumber)
-              throws RuntimeException {
-            return ctType;
-          }
-        };
-
-    EntityCtType source = ctType.getFirstArgCtType().accept(entityCtTypeVisitor, "first");
-    EntityCtType target = ctType.getSecondArgCtType().accept(entityCtTypeVisitor, "second");
-    EntityCtType result = ctType.getResultCtType().accept(entityCtTypeVisitor, "third");
-
-    if (!ctx.getMoreTypes().isSameType(result.getType(), source.getType())) {
-      throw new AptException(Message.DOMA4467, linkerElement, new Object[] {});
-    }
-
-    return new BiFunctionMeta(source, target, result);
-  }
-
   private TypeMirror resolveEntity(
       TypeMirror typeMirror,
       String name,
@@ -295,7 +260,6 @@ private TypeMirror resolveEntity(
   }
 
   private Optional<VariableElement> findAssociationField(TypeElement typeElement, String name) {
-    List<VariableElement> results = new LinkedList<>();
     for (TypeElement t = typeElement;
         t != null && t.asType().getKind() != TypeKind.NONE;
         t = ctx.getMoreTypes().toTypeElement(t.getSuperclass())) {
@@ -321,8 +285,8 @@ private Optional<VariableElement> findAssociationField(TypeElement typeElement,
   private AssociationLinkerMeta createAssociationLinkerMeta(
       VariableElement fieldElement,
       AssociationLinkerAnnot associationLinkerAnnot,
-      BiFunctionMeta biFunctionMeta,
       TypeElement aggregateStrategyElement) {
+
     String propertyPath = associationLinkerAnnot.getPropertyPathValue();
     List<String> propertyPathSegments = Arrays.stream(propertyPath.split("\\.")).toList();
     int propertyPathDepth = propertyPathSegments.size();
@@ -334,15 +298,52 @@ private AssociationLinkerMeta createAssociationLinkerMeta(
     } else {
       ancestorPath = propertyPath.substring(0, propertyPath.lastIndexOf('.'));
     }
+
+    LinkMeta linkMeta = createLinkMeta(fieldElement);
+
     return new AssociationLinkerMeta(
         associationLinkerAnnot,
         ancestorPath,
         associationLinkerAnnot.getPropertyPathValue(),
         propertyPathSegments,
         propertyPathDepth,
         associationLinkerAnnot.getTableAliasValue(),
-        biFunctionMeta,
+        linkMeta.source,
+        linkMeta.target,
         aggregateStrategyElement,
         fieldElement);
   }
+
+  private LinkMeta createLinkMeta(VariableElement linkerElement) {
+    BiFunctionCtType ctType = ctx.getCtTypes().newBiFunctionCtType(linkerElement.asType());
+    if (ctType == null) {
+      throw new AptException(Message.DOMA4465, linkerElement, new Object[] {});
+    }
+    CtTypeVisitor<EntityCtType, String, RuntimeException> entityCtTypeVisitor =
+        new SimpleCtTypeVisitor<>() {
+          @Override
+          protected EntityCtType defaultAction(CtType ctType, String ordinalNumber)
+              throws RuntimeException {
+            throw new AptException(Message.DOMA4466, linkerElement, new Object[] {ordinalNumber});
+          }
+
+          @Override
+          public EntityCtType visitEntityCtType(EntityCtType ctType, String ordinalNumber)
+              throws RuntimeException {
+            return ctType;
+          }
+        };
+
+    EntityCtType source = ctType.getFirstArgCtType().accept(entityCtTypeVisitor, "first");
+    EntityCtType target = ctType.getSecondArgCtType().accept(entityCtTypeVisitor, "second");
+    EntityCtType result = ctType.getResultCtType().accept(entityCtTypeVisitor, "third");
+
+    if (!ctx.getMoreTypes().isSameType(result.getType(), source.getType())) {
+      throw new AptException(Message.DOMA4467, linkerElement, new Object[] {});
+    }
+
+    return new LinkMeta(source, target);
+  }
+
+  private record LinkMeta(EntityCtType source, EntityCtType target) {}
 }

doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/entity/AssociationLinkerMeta.java renamed to doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/aggregate/AssociationLinkerMeta.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.seasar.doma.internal.apt.meta.entity;
+package org.seasar.doma.internal.apt.meta.aggregate;
 
 import java.util.List;
 import java.util.Objects;
@@ -29,7 +29,8 @@ public record AssociationLinkerMeta(
     List<String> propertyPathSegments,
     int propertyPathDepth,
     String tableAlias,
-    BiFunctionMeta biFunctionMeta,
+    EntityCtType source,
+    EntityCtType target,
     TypeElement classElement,
     VariableElement filedElement) {
 
@@ -38,16 +39,9 @@ public record AssociationLinkerMeta(
     Objects.requireNonNull(propertyPath);
     Objects.requireNonNull(propertyPathSegments);
     Objects.requireNonNull(tableAlias);
-    Objects.requireNonNull(biFunctionMeta);
+    Objects.requireNonNull(source);
+    Objects.requireNonNull(target);
     Objects.requireNonNull(classElement);
     Objects.requireNonNull(filedElement);
   }
-
-  public EntityCtType source() {
-    return biFunctionMeta.source();
-  }
-
-  public EntityCtType target() {
-    return biFunctionMeta.target();
-  }
 }

doma-processor/src/main/java/org/seasar/doma/internal/apt/meta/entity/BiFunctionMeta.java

@@ -29,8 +29,8 @@
 import org.seasar.doma.internal.apt.generator.Generator;
 import org.seasar.doma.internal.apt.generator.Printer;
 import org.seasar.doma.internal.apt.meta.TypeElementMetaFactory;
-import org.seasar.doma.internal.apt.meta.entity.AggregateStrategyMeta;
-import org.seasar.doma.internal.apt.meta.entity.AggregateStrategyMetaFactory;
+import org.seasar.doma.internal.apt.meta.aggregate.AggregateStrategyMeta;
+import org.seasar.doma.internal.apt.meta.aggregate.AggregateStrategyMetaFactory;
 
 @SupportedAnnotationTypes({"org.seasar.doma.AggregateStrategy"})
 @SupportedOptions({