Merge pull request #319 from domaframework/feat/geometric-type

Add an example for PostgreSQL geometric types

Author: nakamura-to

README.md

@@ -9,6 +9,7 @@ This repository includes the following examples:
 * [example-sql-annotation](example-sql-annotation) - Uses SQL annotations to store SQL templates.
 * [example-criteria](example-criteria) - Uses the Criteria API.
 * [example-jpms](example-jpms) - Uses the Java Platform Module System (JPMS).
+* [example-geometric-type](example-geometric-type) - Uses Geometric types of PostgreSQL.
 
 ER diagram
 ---------------------

common/build.gradle.kts

@@ -9,5 +9,7 @@ tasks {
             mapOf(
                 "doma.domain.converters" to "example.common.domain.DomainConverterProvider",
             )
+        // If you are not using Eclipse, you can simply write the above code as follows without using aptOptions;
+        // options.compilerArgs.add("-Adoma.domain.converters=example.common.domain.DomainConverterProvider")
     }
 }

example-geometric-type/.gitignore

@@ -0,0 +1,13 @@
+.classpath
+.factorypath
+.project
+.settings
+/.apt_generated
+/bin
+/build
+.gradle
+.idea
+out
+/.apt_generated_tests/
+.vscode
+.sdkmanrc

example-geometric-type/build.gradle.kts

@@ -0,0 +1,21 @@
+plugins {
+    id("java")
+}
+
+dependencies {
+    implementation(libs.jdbc.postgresql)
+    testImplementation(platform(libs.testcontainers.bom))
+    testImplementation(libs.testcontainers.postgresql)
+}
+
+tasks {
+    compileJava {
+        val aptOptions = extensions.getByType<com.diffplug.gradle.eclipse.apt.AptPlugin.AptOptions>()
+        aptOptions.processorArgs =
+            mapOf(
+                "doma.domain.converters" to "example.geometric.type.domain.DomainConverterProvider",
+            )
+        // If you are not using Eclipse, you can simply write the above code as follows without using aptOptions;
+        // options.compilerArgs.add("-Adoma.domain.converters=example.geometric.type.domain.DomainConverterProvider")
+    }
+}

example-geometric-type/src/main/java/example/geometric/type/dao/CircleZoneDao.java

@@ -0,0 +1,18 @@
+package example.geometric.type.dao;
+
+import example.geometric.type.entity.CircleZone;
+import org.seasar.doma.Dao;
+import org.seasar.doma.Insert;
+import org.seasar.doma.Select;
+import org.seasar.doma.Sql;
+
+@Dao
+public interface CircleZoneDao {
+
+  @Sql("select /*%expand */* from circle_zone where id = /* id */0")
+  @Select
+  CircleZone selectById(Integer id);
+
+  @Insert
+  int insert(CircleZone circleZone);
+}

example-geometric-type/src/main/java/example/geometric/type/dao/LandmarkDao.java

@@ -0,0 +1,18 @@
+package example.geometric.type.dao;
+
+import example.geometric.type.entity.Landmark;
+import org.seasar.doma.Dao;
+import org.seasar.doma.Insert;
+import org.seasar.doma.Select;
+import org.seasar.doma.Sql;
+
+@Dao
+public interface LandmarkDao {
+
+  @Sql("select /*%expand */* from landmark where id = /* id */0")
+  @Select
+  Landmark selectById(Integer id);
+
+  @Insert
+  int insert(Landmark landmark);
+}

example-geometric-type/src/main/java/example/geometric/type/dao/ScriptDao.java

@@ -0,0 +1,14 @@
+package example.geometric.type.dao;
+
+import org.seasar.doma.Dao;
+import org.seasar.doma.Script;
+
+@Dao
+public interface ScriptDao {
+
+  @Script
+  void create();
+
+  @Script
+  void drop();
+}

example-geometric-type/src/main/java/example/geometric/type/domain/Circle.java

@@ -0,0 +1,3 @@
+package example.geometric.type.domain;
+
+public record Circle(Point center, double radius) {}

example-geometric-type/src/main/java/example/geometric/type/domain/CircleTypeProvider.java

@@ -0,0 +1,64 @@
+package example.geometric.type.domain;
+
+import java.sql.CallableStatement;
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Types;
+import org.postgresql.geometric.PGcircle;
+import org.postgresql.geometric.PGpoint;
+import org.seasar.doma.ExternalDomain;
+import org.seasar.doma.jdbc.domain.JdbcTypeProvider;
+import org.seasar.doma.jdbc.type.AbstractJdbcType;
+import org.seasar.doma.jdbc.type.JdbcType;
+
+@ExternalDomain
+public class CircleTypeProvider extends JdbcTypeProvider<Circle> {
+
+  private static final CircleType circleType = new CircleType();
+
+  @Override
+  public JdbcType<Circle> getJdbcType() {
+    return circleType;
+  }
+}
+
+class CircleType extends AbstractJdbcType<Circle> {
+
+  protected CircleType() {
+    super(Types.OTHER);
+  }
+
+  @Override
+  protected Circle doGetValue(ResultSet resultSet, int index) throws SQLException {
+    PGcircle c = resultSet.getObject(index, PGcircle.class);
+    return toCircle(c);
+  }
+
+  @Override
+  protected void doSetValue(PreparedStatement preparedStatement, int index, Circle value)
+      throws SQLException {
+    PGpoint p = new PGpoint(value.center().x(), value.center().y());
+    PGcircle c = new PGcircle(p, value.radius());
+    preparedStatement.setObject(index, c);
+  }
+
+  @Override
+  protected Circle doGetValue(CallableStatement callableStatement, int index) throws SQLException {
+    PGcircle c = callableStatement.getObject(index, PGcircle.class);
+    return toCircle(c);
+  }
+
+  @Override
+  protected String doConvertToLogFormat(Circle value) {
+    return value.toString();
+  }
+
+  static Circle toCircle(PGcircle c) {
+    if (c == null) {
+      return null;
+    }
+    Point center = PointType.toPoint(c.center);
+    return new Circle(center, c.radius);
+  }
+}

example-geometric-type/src/main/java/example/geometric/type/domain/DomainConverterProvider.java

@@ -0,0 +1,6 @@
+package example.geometric.type.domain;
+
+import org.seasar.doma.DomainConverters;
+
+@DomainConverters({CircleTypeProvider.class, PointTypeProvider.class})
+public class DomainConverterProvider {}