Add Geobuf Workspace (#63)

Add Geobuf Workspace

Author: jericks

.gitignore

@@ -2,4 +2,6 @@
 .project
 .settings/
 /target/
-/data/
+/data/
+.idea
+*.iml

doc/api/workspace/geobuf.rst

@@ -0,0 +1,71 @@
+:class:`workspace.Geobuf`
+=====================
+
+.. class:: workspace.Geobuf(config)
+
+    :arg config: ``Object`` Configuration object.
+
+    Create a workspace from an Geobuf directory.
+
+
+Config Properties
+-----------------
+
+.. describe:: file
+
+    ``String``
+    Directory path to the Geobuf files (required).
+
+Properties
+----------
+
+.. attribute:: Geobuf.layers
+
+    ``Array``
+    The available layers in the workspace.
+
+.. attribute:: Geobuf.names
+
+    ``Array``
+    The available layer names in the workspace.
+
+
+Methods
+-------
+
+
+.. function:: Geobuf.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:: Geobuf.close
+
+    Close the workspace.  This discards any existing connection to the
+    underlying data store and discards the reference to the store.
+
+.. function:: Geobuf.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

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

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

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

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

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

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

@@ -35,6 +35,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: Geobu"] = require("./workspace/test_geobuf");
 exports["test: Memory"] = require("./workspace/test_memory");
 // exports["test: PostGIS"] = require("./workspace/test_postgis");
 

src/test/resources/org/geoscript/js/tests/geoscript/workspace/test_geobuf.js

@@ -0,0 +1,45 @@
+var ASSERT = require("assert");
+var WORKSPACE = require("geoscript/workspace");
+var LAYER = require("geoscript/layer");
+var GEOM = require("geoscript/geom");
+var FS = require("fs");
+
+exports["test: constructor"] = function() {
+
+    var Files = Packages.java.nio.file.Files;
+    var file = Files.createTempDirectory("geobuf").toFile().getAbsolutePath();
+    var geobuf = new WORKSPACE.Geobuf({file: file});
+    
+    ASSERT.ok(geobuf instanceof WORKSPACE.Workspace, "instanceof Workspace");
+    ASSERT.ok(geobuf instanceof WORKSPACE.Geobuf, "instanceof Geobuf");
+    
+    geobuf.close();
+
+};
+
+exports["test: create"] = function() {
+
+    var Files = Packages.java.nio.file.Files;
+    var file = Files.createTempDirectory("geobuf").toFile().getAbsolutePath();
+    var geobuf = new WORKSPACE.Geobuf({file: file});
+
+    var layer = new LAYER.Layer({
+        name: "cities",
+       fields: [{
+           name: "name", type: "String"
+       }, {
+           name: "geom", type: "Point"
+       }]
+    });
+    var geobufLayer = geobuf.add(layer);
+
+    geobufLayer.add({name: "San Francisco", geom: new GEOM.Point([-122.42, 37.78])});
+    geobufLayer.add({name: "New York", geom: new GEOM.Point([-73.58, 40.47])});
+    ASSERT.ok(geobufLayer.count == 2);
+
+    geobuf.close();
+};
+
+if (require.main == module.id) {
+    system.exit(require("test").run(exports));
+}