Flatgeobuffer driver

docs/CHANGELOG.md

@@ -1,4 +1,4 @@
-## Changelog for v2.2.1
+## Changelog for v2.1.1
 + Next version
 + Update EPSG 2100 definition for GGRS87 / Greek Grid transformation
 + Add geojson utility to convert a resultset to JSON map
@@ -24,4 +24,6 @@
 + Set scope as test for slf4j-simple
 + Zip and unzip functions with subfolders
 + GeoJson driver must be able to read json extension
-+ GeoJson handle the M ordinate. The limitation is only ZM is supported (default Z value to 0 if M is given but not Z)
++ GeoJson handle the M ordinate. The limitation is only ZM is supported (default Z value to 0 if M is given but not Z)
++ GeoJson read the optional ID field on feature as an attribute, but currently it will be saved back into feature attribute.
++ FlatGeobuf driver. Read Write driver and FileTable. This driver does not support mixed geometry type. On write a spatial index is created by default. The spatial index on file table is not currently supported. 

h2gis-functions/pom.xml

@@ -56,6 +56,10 @@
             <groupId>org.orbisgis</groupId>
             <artifactId>poly2tri</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.wololo</groupId>
+            <artifactId>flatgeobuf</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>org.orbisgis</groupId>

h2gis-functions/src/main/java/org/h2gis/functions/factory/H2GISDBFactory.java

@@ -59,9 +59,9 @@ private H2GISDBFactory() {
 
     /**
      * Open the connection to an existing database
-     * @param dbName
-     * @return
-     * @throws SQLException
+     * @param dbName Database name
+     * @return Active connection
+     * @throws SQLException Exception
      */
     public static Connection openSpatialDataBase(String dbName) throws SQLException {
         String dbFilePath = getDataBasePath(dbName);       
@@ -75,10 +75,9 @@ public static Connection openSpatialDataBase(String dbName) throws SQLException
      * Create a spatial database
      * @param dbName filename
      * @return Connection
-     * @throws java.sql.SQLException
-     * @throws java.lang.ClassNotFoundException
+     * @throws java.sql.SQLException SQL Exception
      */
-    public static Connection createSpatialDataBase(String dbName)throws SQLException, ClassNotFoundException {
+    public static Connection createSpatialDataBase(String dbName)throws SQLException {
         return createSpatialDataBase(dbName,true);
     }
 
@@ -100,7 +99,7 @@ private static String getDataBasePath(String dbName) {
      * @param dbName DataBase name, or path URI
      * @param initSpatial True to enable basic spatial capabilities
      * @return DataSource
-     * @throws SQLException
+     * @throws SQLException SQL issue
      */
     public static DataSource createDataSource(String dbName ,boolean initSpatial) throws SQLException {
         return createDataSource(dbName, initSpatial, H2_PARAMETERS);
@@ -110,7 +109,7 @@ public static DataSource createDataSource(String dbName ,boolean initSpatial) th
      * Create a database, init spatial funcyion and return a DataSource
      * @param properties for the opening of the DataBase.
      * @return a DataSource
-     * @throws SQLException
+     * @throws SQLException  SQL issue
      */
     public static DataSource createDataSource(Properties properties) throws SQLException {
         return createDataSource(properties, true);
@@ -121,7 +120,7 @@ public static DataSource createDataSource(Properties properties) throws SQLExcep
      * @param properties for the opening of the DataBase.
      * @param initSpatial true to load the spatial functions
      * @return a DataSource
-     * @throws SQLException
+     * @throws SQLException  SQL issue
      */
     public static DataSource createDataSource(Properties properties, boolean initSpatial) throws SQLException {
         // Create H2 memory DataSource
@@ -138,11 +137,11 @@ public static DataSource createDataSource(Properties properties, boolean initSpa
 
         /**
          * Create a database and return a DataSource
-         * @param dbName
-         * @param initSpatial
-         * @param h2Parameters
-         * @return
-         * @throws SQLException
+         * @param dbName Database name
+         * @param initSpatial true to load the spatial functions
+         * @param h2Parameters Additional h2 parameters
+         * @return DataSource instance
+         * @throws SQLException SQL issue
          */
     public static DataSource createDataSource(String dbName ,boolean initSpatial, String h2Parameters) throws SQLException {
         // Create H2 memory DataSource
@@ -164,9 +163,9 @@ public static DataSource createDataSource(String dbName ,boolean initSpatial, St
 
     /**
      * 
-     * @param dbName
-     * @param h2_PARAMETERS
-     * @return 
+     * @param dbName Database name
+     * @param h2_PARAMETERS User defined h2 parameters
+     * @return The path of the database
      */
     private static String initDBFile( String dbName, String h2_PARAMETERS ) {
         String dbFilePath = getDataBasePath(dbName);
@@ -189,10 +188,9 @@ private static String initDBFile( String dbName, String h2_PARAMETERS ) {
      * @param initSpatial If true add spatial features to the database
      * @param h2Parameters Additional h2 parameters
      * @return Connection
-     * @throws java.sql.SQLException
-     * @throws java.lang.ClassNotFoundException
+     * @throws java.sql.SQLException SQL Exception
      */
-    public static Connection createSpatialDataBase(String dbName,boolean initSpatial, String h2Parameters )throws SQLException, ClassNotFoundException {
+    public static Connection createSpatialDataBase(String dbName,boolean initSpatial, String h2Parameters ) throws SQLException {
         String databasePath = initDBFile(dbName, h2Parameters);
         org.h2.Driver.load();
         // Keep a connection alive to not close the DataBase on each unit test
@@ -210,10 +208,9 @@ public static Connection createSpatialDataBase(String dbName,boolean initSpatial
      * @param dbName filename
      * @param initSpatial If true add spatial features to the database
      * @return Connection
-     * @throws java.sql.SQLException
-     * @throws java.lang.ClassNotFoundException
+     * @throws java.sql.SQLException Database issue
      */
-    public static Connection createSpatialDataBase(String dbName, boolean initSpatial )throws SQLException, ClassNotFoundException {
+    public static Connection createSpatialDataBase(String dbName, boolean initSpatial )throws SQLException {
         return createSpatialDataBase(dbName, initSpatial, H2_PARAMETERS);
     }
 

h2gis-functions/src/main/java/org/h2gis/functions/factory/H2GISFunctions.java

@@ -343,7 +343,7 @@ public static Function[] getBuiltInsFunctions() {
      * @param connection Active H2 connection
      * @param BundleSymbolicName OSGi Bundle symbolic name
      * @param BundleVersion OSGi Bundle version
-     * @throws java.sql.SQLException
+     * @throws java.sql.SQLException  Database issue
      */
     public static void load(Connection connection, String BundleSymbolicName, String BundleVersion) throws SQLException {
         String packagePrepend = BundleSymbolicName+":"+BundleVersion+":";
@@ -354,7 +354,7 @@ public static void load(Connection connection, String BundleSymbolicName, String
     /**
      * Register GEOMETRY type and register H2GIS functions
      * @param connection Active H2 connection
-     * @throws java.sql.SQLException
+     * @throws java.sql.SQLException  Database issue
      */
     public static void load(Connection connection) throws SQLException {
         org.locationtech.jts.JTSVersion jtsVersion = org.locationtech.jts.JTSVersion.CURRENT_VERSION;
@@ -369,7 +369,7 @@ public static void load(Connection connection) throws SQLException {
     /**
      * Register view in order to create GEOMETRY_COLUMNS standard table.
      * @param connection Open connection
-     * @throws java.sql.SQLException
+     * @throws java.sql.SQLException  Database issue
      */
     public static void registerSpatialTables(Connection connection) throws SQLException {
         Statement st = connection.createStatement();
@@ -502,7 +502,7 @@ public static String getAlias(Function function) {
      * Remove the specified function from the provided DataBase connection
      * @param st Active statement
      * @param function function to remove
-     * @throws SQLException
+     * @throws SQLException  Database issue
      */
     public static void unRegisterFunction(Statement st, Function function) throws SQLException {
         String functionAlias = getStringProperty(function, Function.PROP_NAME);

h2gis-functions/src/main/java/org/h2gis/functions/io/DriverManager.java

@@ -24,6 +24,8 @@
 import org.h2gis.api.*;
 import org.h2gis.functions.io.dbf.DBFDriverFunction;
 import org.h2gis.functions.io.dbf.DBFEngine;
+import org.h2gis.functions.io.fgb.FGBDriverFunction;
+import org.h2gis.functions.io.fgb.FGBEngine;
 import org.h2gis.functions.io.shp.SHPDriverFunction;
 import org.h2gis.functions.io.shp.SHPEngine;
 import org.h2gis.utilities.TableLocation;
@@ -41,17 +43,20 @@
  * Manage additional table engines in H2.
  * Use the appropriate driver to open a specified file path.
  * @author Nicolas Fortin
- * @author Sylvain PALOMINOS (UBS 2019)
+ * @author Sylvain Paliminos (UBS 2019)
+ * @author Erwan Bocher (CNRS)
  */
 public class DriverManager extends AbstractFunction implements ScalarFunction, DriverFunction {
 
     private static final DriverDef[] DRIVERS = new DriverDef[] {
             new DriverDef(DBFEngine.class.getName(),"dbf"),
-            new DriverDef(SHPEngine.class.getName(),"shp")};
+            new DriverDef(SHPEngine.class.getName(),"shp"),
+            new DriverDef(FGBEngine.class.getName(), "fgb")};
     private static final int FORMAT = 0;
     private static final int DESCRIPTION = 1;
     private static final String[][] formatDescription = new String[][] {{"dbf", DBFDriverFunction.DESCRIPTION},
-                                                                        {"shp", SHPDriverFunction.DESCRIPTION}};
+                                                                        {"shp", SHPDriverFunction.DESCRIPTION},
+                                                                        {"fgb", FGBDriverFunction.DESCRIPTION}};
 
     public DriverManager() {
         addProperty(PROP_NAME, "FILE_TABLE");
@@ -199,12 +204,12 @@ public String[]  importFile(Connection connection, String tableReference, File f
 
     /**
      * Method to check the import and export arguments
-     * @param connection
-     * @param tableReference
-     * @param fileName
-     * @param progress
-     * @return
-     * @throws SQLException
+     * @param connection Active connection, do not close this connection.
+     * @param tableReference Table name
+     * @param fileName Path of the data file
+     * @param progress Progress instance
+     * @return progress instance
+     * @throws SQLException Database issue
      */
     public static ProgressVisitor check(Connection connection, String tableReference, File fileName, ProgressVisitor progress) throws SQLException {
         if (connection == null) {