BAEL-1334 Guide to Hibernate Spatial (#3139)

* BAEL-1334 Guide to Hibernate Spatial

* BAEL-1334 Guide to Hibernate Spatial

Moving the files to hibernate5 from libraries

* Reverting the pom file

hibernate5/pom.xml

@@ -17,12 +17,15 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<!-- Maven plugins -->
         <maven-compiler-plugin.version>3.6.0</maven-compiler-plugin.version>
-	</properties>
+        <hibernate.version>5.2.12.Final</hibernate.version>
+        <mysql.version>6.0.6</mysql.version>
+        <mariaDB4j.version>2.2.3</mariaDB4j.version>
+    </properties>
 	<dependencies>
         <dependency>
             <groupId>org.hibernate</groupId>
             <artifactId>hibernate-core</artifactId>
-            <version>5.2.12.Final</version>
+            <version>${hibernate.version}</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>
@@ -40,6 +43,21 @@
             <artifactId>h2</artifactId>
             <version>1.4.194</version>
         </dependency>
+        <dependency>
+            <groupId>org.hibernate</groupId>
+            <artifactId>hibernate-spatial</artifactId>
+            <version>${hibernate.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>mysql</groupId>
+            <artifactId>mysql-connector-java</artifactId>
+            <version>${mysql.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.vorburger.mariaDB4j</groupId>
+            <artifactId>mariaDB4j</artifactId>
+            <version>${mariaDB4j.version}</version>
+        </dependency>
 	</dependencies>
 	<build>
         <finalName>hibernate5</finalName>

hibernate5/src/main/java/com/baeldung/hibernate/HibernateUtil.java

@@ -5,6 +5,7 @@ import com.baeldung.hibernate.pojo.EntityDescription;
 import com.baeldung.hibernate.pojo.OrderEntry;
 import com.baeldung.hibernate.pojo.OrderEntryIdClass;
 import com.baeldung.hibernate.pojo.OrderEntryPK;
+import com.baeldung.hibernate.pojo.PointEntity;
 import com.baeldung.hibernate.pojo.Product;
 import com.baeldung.hibernate.pojo.Phone;
 import com.baeldung.hibernate.pojo.TemporalValues;
@@ -23,6 +24,7 @@ import com.baeldung.hibernate.pojo.inheritance.Person;
 import com.baeldung.hibernate.pojo.inheritance.Pet;
 import com.baeldung.hibernate.pojo.inheritance.Vehicle;
 
+import org.apache.commons.lang3.StringUtils;
 import org.hibernate.SessionFactory;
 import org.hibernate.boot.Metadata;
 import org.hibernate.boot.MetadataSources;
@@ -36,8 +38,14 @@ import java.util.Properties;
 
 public class HibernateUtil {
     private static SessionFactory sessionFactory;
+    private static String PROPERTY_FILE_NAME;
 
     public static SessionFactory getSessionFactory() throws IOException {
+        return getSessionFactory(null);
+    }
+
+    public static SessionFactory getSessionFactory(String propertyFileName) throws IOException {
+        PROPERTY_FILE_NAME = propertyFileName;
         if (sessionFactory == null) {
             ServiceRegistry serviceRegistry = configureServiceRegistry();
             sessionFactory = makeSessionFactory(serviceRegistry);
@@ -70,6 +78,7 @@ public class HibernateUtil {
         metadataSources.addAnnotatedClass(Vehicle.class);
         metadataSources.addAnnotatedClass(Car.class);
         metadataSources.addAnnotatedClass(Bag.class);
+        metadataSources.addAnnotatedClass(PointEntity.class);
 
         Metadata metadata = metadataSources.buildMetadata();
         return metadata.getSessionFactoryBuilder()
@@ -86,12 +95,11 @@ public class HibernateUtil {
     private static Properties getProperties() throws IOException {
         Properties properties = new Properties();
         URL propertiesURL = Thread.currentThread()
-                .getContextClassLoader()
+          .getContextClassLoader()
-                .getResource("hibernate.properties");
+          .getResource(StringUtils.defaultString(PROPERTY_FILE_NAME, "hibernate.properties"));
         try (FileInputStream inputStream = new FileInputStream(propertiesURL.getFile())) {
             properties.load(inputStream);
         }
         return properties;
     }
-
 }

hibernate5/src/main/java/com/baeldung/hibernate/pojo/PointEntity.java

@@ -0,0 +1,41 @@
+package com.baeldung.hibernate.pojo;
+
+import com.vividsolutions.jts.geom.Point;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+
+@Entity
+public class PointEntity {
+
+    @Id
+    @GeneratedValue
+    private Long id;
+
+    private Point point;
+
+    public PointEntity() {
+    }
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public Point getPoint() {
+        return point;
+    }
+
+    public void setPoint(Point point) {
+        this.point = point;
+    }
+
+    @Override
+    public String toString() {
+        return "PointEntity{" + "id=" + id + ", point=" + point + '}';
+    }
+}

hibernate5/src/test/java/com/baeldung/hibernate/HibernateSpatialTest.java

@@ -0,0 +1,97 @@
+package com.baeldung.hibernate;
+
+import com.baeldung.hibernate.pojo.PointEntity;
+import com.vividsolutions.jts.geom.Geometry;
+import com.vividsolutions.jts.geom.Point;
+import com.vividsolutions.jts.io.ParseException;
+import com.vividsolutions.jts.io.WKTReader;
+import org.hibernate.Session;
+import org.hibernate.Transaction;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import javax.persistence.Query;
+import java.io.IOException;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+public class HibernateSpatialTest {
+
+    private Session session;
+    private Transaction transaction;
+
+    @Before
+    public void setUp() throws IOException {
+        session = HibernateUtil.getSessionFactory("hibernate-spatial.properties")
+          .openSession();
+        transaction = session.beginTransaction();
+    }
+
+    @After
+    public void tearDown() {
+        transaction.rollback();
+        session.close();
+    }
+
+    @Test
+    public void shouldConvertWktToGeometry() throws ParseException {
+        Geometry geometry = wktToGeometry("POINT (2 5)");
+        assertEquals("Point", geometry.getGeometryType());
+        assertTrue(geometry instanceof Point);
+    }
+
+    @Test
+    public void shouldInsertAndSelectPoints() throws ParseException {
+        PointEntity entity = new PointEntity();
+        entity.setPoint((Point) wktToGeometry("POINT (1 1)"));
+
+        session.persist(entity);
+        PointEntity fromDb = session.find(PointEntity.class, entity.getId());
+        assertEquals("POINT (1 1)", fromDb.getPoint().toString());
+    }
+
+    @Test
+    public void shouldSelectDisjointPoints() throws ParseException {
+        insertPoint("POINT (1 2)");
+        insertPoint("POINT (3 4)");
+        insertPoint("POINT (5 6)");
+
+        Point point = (Point) wktToGeometry("POINT (3 4)");
+        Query query = session.createQuery("select p from PointEntity p "
+          + "where disjoint(p.point, :point) = true", PointEntity.class);
+        query.setParameter("point", point);
+        assertEquals("POINT (1 2)", ((PointEntity) query.getResultList().get(0)).getPoint().toString());
+        assertEquals("POINT (5 6)", ((PointEntity) query.getResultList().get(1)).getPoint().toString());
+    }
+
+    @Test
+    public void shouldSelectAllPointsWithinPolygon() throws ParseException {
+        insertPoint("POINT (1 1)");
+        insertPoint("POINT (1 2)");
+        insertPoint("POINT (3 4)");
+        insertPoint("POINT (5 6)");
+
+        Query query = session.createQuery("select p from PointEntity p where within(p.point, :area) = true",
+          PointEntity.class);
+        query.setParameter("area", wktToGeometry("POLYGON((0 0, 0 5, 5 5, 5 0, 0 0))"));
+        assertEquals(3, query.getResultList().size());
+        assertEquals("POINT (1 1)", ((PointEntity) query.getResultList().get(0)).getPoint().toString());
+        assertEquals("POINT (1 2)", ((PointEntity) query.getResultList().get(1)).getPoint().toString());
+        assertEquals("POINT (3 4)", ((PointEntity) query.getResultList().get(2)).getPoint().toString());
+    }
+
+    private void insertPoint(String point) throws ParseException {
+        PointEntity entity = new PointEntity();
+        entity.setPoint((Point) wktToGeometry(point));
+        session.persist(entity);
+    }
+
+    private Geometry wktToGeometry(String wellKnownText) throws ParseException {
+        WKTReader fromText = new WKTReader();
+        Geometry geom = null;
+        geom = fromText.read(wellKnownText);
+        return geom;
+    }
+}

hibernate5/src/test/resources/hibernate-spatial.properties

@@ -0,0 +1,10 @@
+hibernate.dialect=org.hibernate.spatial.dialect.mysql.MySQL56SpatialDialect
+hibernate.connection.driver_class=com.mysql.jdbc.Driver
+hibernate.connection.url=jdbc:mysql://localhost:3306/hibernate-spatial
+hibernate.connection.username=root
+hibernate.connection.password=pass
+hibernate.connection.pool_size=5
+hibernate.show_sql=true
+hibernate.format_sql=true
+hibernate.max_fetch_depth=5
+hibernate.hbm2ddl.auto=create-drop