Merge pull request #42 from jericks/gpkg_workspace

Add GeoPackage Workspace

Author: jericks

doc/api/workspace/geopackage.rst

@@ -0,0 +1,71 @@
+:class:`workspace.GeoPackage`
+=====================
+
+.. class:: workspace.GeoPackage(config)
+
+    :arg config: ``Object`` Configuration object.
+
+    Create a workspace from an GeoPackage database.
+
+
+Config Properties
+-----------------
+
+.. describe:: database
+
+    ``String``
+    Path to the database (required).
+
+Properties
+----------
+
+.. attribute:: GeoPackage.layers
+
+    ``Array``
+    The available layers in the workspace.
+
+.. attribute:: GeoPackage.names
+
+    ``Array``
+    The available layer names in the workspace.
+
+
+Methods
+-------
+
+
+.. function:: GeoPackage.add
+
+    :arg layer: :class:`layer.Layer` The layer to be added.
+    :arg options: ``Object`` Options for adding the layer.
+    
+    Options:
+     * `name`: ``String`` Name for the new layer.
+     * `filter`: :class:`filter.Filter` Filter to apply to features before adding.
+     * `projection`: :class:`proj.Projection` Destination projection for the layer.
+    
+    :returns: :class:`layer.Layer`
+    
+    Create a new layer in this workspace with the features from an existing
+    layer.  If a layer with the same name already exists in this workspace,
+    you must provide a new name for the layer.
+
+.. function:: GeoPackage.close
+
+    Close the workspace.  This discards any existing connection to the
+    underlying data store and discards the reference to the store.
+
+.. function:: GeoPackage.get
+
+    :arg name: ``String`` Layer name.
+    :returns: :class:`layer.Layer`
+    
+    Get a layer by name.  Returns ``undefined`` if name doesn't correspond
+    to a layer source in the workspace.
+
+
+
+
+
+
+

pom.xml

@@ -134,6 +134,11 @@
             <artifactId>gt-swing</artifactId>
             <version>${gt.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.geotools</groupId>
+            <artifactId>gt-geopkg</artifactId>
+            <version>${gt.version}</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

src/main/resources/org/geoscript/js/lib/geoscript/workspace.js

@@ -39,6 +39,9 @@ exports.H2 = require("./workspace/h2").H2;
 /** api: classes[] = mysql */
 exports.MySQL = require("./workspace/mysql").MySQL;
 
+/** api: classes[] = geopackage */
+exports.GeoPackage = require("./workspace/geopackage").GeoPackage;
+
 /** private: classes[] = spatialite */
 exports.SpatiaLite = require("./workspace/spatialite").SpatiaLite;
 

src/main/resources/org/geoscript/js/lib/geoscript/workspace/geopackage.js

@@ -0,0 +1,88 @@
+var register = require("./util").register;
+var Factory = require("../factory").Factory;
+var Workspace = require("./workspace").Workspace;
+var UTIL = require("../util");
+
+var GeoPkgDataStoreFactory = Packages.org.geotools.geopkg.GeoPkgDataStoreFactory;
+
+/** private: (define)
+ *  module = workspace
+ *  class = GeoPackage
+ */
+
+var prepConfig = function(config) {
+  if (config) {
+    if (typeof config === "string") {
+      config = {database: config};
+    }
+    if (!(typeof config.database === "string" || config.database instanceof file.Path)) {
+      throw "GeoPackage config must include database path.";
+    }
+    config = {
+      database: String(config.database)
+    };
+  }
+  return config;
+};
+
+/** private: (extends)
+ *  workspace/workspace.js
+ */
+var GeoPackage = UTIL.extend(Workspace, {
+
+  /** private: config[database]
+   *  ``String``
+   *  Path to the database (required).
+   */
+
+  /** private: constructor
+   *  .. class:: GeoPackage
+   *
+   *    :arg config: ``Object`` Configuration object.
+   *
+   *    Create a workspace from a GeoPackage enabled database.
+   */
+  constructor: function GeoPackage(config) {
+    Workspace.prototype.constructor.apply(this, [prepConfig(config)]);
+  },
+
+  /** private: method[_create]
+   *  :arg config: ``Object``
+   *  :returns: ``org.geotools.jdbc.JDBCDataStore``
+   *
+   *  Create the underlying store for the workspace.
+   */
+  _create: function(config) {
+    config.dbtype = "geopkg";
+    var factory = new GeoPkgDataStoreFactory();
+    return factory.createDataStore(config);
+  },
+
+  /** private: property[config]
+   */
+  get config() {
+    return {
+      type: this.constructor.name,
+      database: this.database
+    };
+  }
+
+});
+
+exports.GeoPackage = GeoPackage;
+
+// register a geopackage factory for the module
+register(new Factory(GeoPackage, {
+  handles: function(config) {
+    var capable = false;
+    if (typeof config.type === "string" && config.type.toLowerCase() === "geopackage") {
+      try {
+        config = prepConfig(config);
+        capable = true;
+      } catch (err) {
+        // pass
+      }
+    }
+    return capable;
+  }
+}));

src/test/resources/org/geoscript/js/tests/admin.js

@@ -54,6 +54,19 @@ var meta = {
             }
         }
     },
+    geopkg: {
+            source: path("data/geopkg.zip"),
+            dest: path("tmp"),
+            setUp: function() {
+                meta.geopkg.tearDown();
+                unzip(meta.geopkg.source, meta.geopkg.dest);
+            },
+            tearDown: function() {
+                if (FS.exists(meta.geopkg.dest)) {
+                    FS.removeTree(meta.geopkg.dest);
+                }
+            }
+        },
     pg: {
         driver: new Packages.org.postgresql.Driver,
         setUp: function() {

src/test/resources/org/geoscript/js/tests/data/geopkg.zip

@@ -34,6 +34,7 @@ exports["test: Workspace.from_"] = function() {
 
 exports["test: Directory"] = require("./workspace/test_directory");
 exports["test: H2"] = require("./workspace/test_h2");
+exports["test: GeoPackage"] = require("./workspace/test_geopackage");
 exports["test: Memory"] = require("./workspace/test_memory");
 // exports["test: PostGIS"] = require("./workspace/test_postgis");
 

src/test/resources/org/geoscript/js/tests/geoscript/test_workspace.js

@@ -0,0 +1,45 @@
+var ASSERT = require("assert");
+var WORKSPACE = require("geoscript/workspace");
+var LAYER = require("geoscript/layer");
+var FS = require("fs");
+var admin = require("../../admin");
+
+var database = FS.join(admin.geopkg.dest, "geoscript.gpkg");
+exports.setUp = admin.geopkg.setUp;
+exports.tearDown = admin.geopkg.tearDown;
+
+exports["test: constructor"] = function() {
+
+    var geopkg = new WORKSPACE.GeoPackage();
+    
+    ASSERT.ok(geopkg instanceof WORKSPACE.Workspace, "instanceof Workspace");
+    ASSERT.ok(geopkg instanceof WORKSPACE.GeoPackage, "instanceof GeoPackage");
+    
+    geopkg.close();
+
+};
+
+exports["test: names"] = function() {
+
+    var geopkg = new WORKSPACE.GeoPackage({database: database});
+
+    ASSERT.ok(geopkg.names.indexOf("states") > -1, "geopkg.names includes 'states'");
+
+    geopkg.close();
+    
+};
+
+exports["test: get"] = function() {
+
+    var geopkg = new WORKSPACE.GeoPackage({database: database});
+    
+    var states = geopkg.get("states");
+    ASSERT.ok(states instanceof LAYER.Layer, "get returns a layer instance");
+
+    geopkg.close();
+
+};
+
+if (require.main == module.id) {
+    system.exit(require("test").run(exports));
+}