neo4j-spatial 0.0.1-java

data/examples/osm_import.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env jruby
+
+# useful if being run inside a source code checkout
+$: << 'lib'
+$: << '../lib'
+
+require 'rubygems'
+require 'neo4j/spatial'
+require 'neo4j/spatial/cmd'
+require 'fileutils'
+
+$files = Neo4j::Spatial::Cmd.args
+
+if $help || $files.length < 1
+  puts "usage: osm_import.rb <-d> <-D storage_path> file.osm"
+  puts "\t-d\tDelete database first"
+  puts "\t-D\tUse specified database location"
+  exit
+end
+
+if $delete
+    puts "Deleting previous database #{Neo4j::Config[:storage_path]}"
+    FileUtils.rm_rf Neo4j::Config[:storage_path]
+end
+
+$files.each do |file|
+  osm_importer = Neo4j::Spatial::OSMImporter.new
+  osm_importer.import file
+end

data/examples/osm_layer.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env jruby
+
+# useful if being run inside a source code checkout
+$: << 'lib'
+$: << '../lib'
+
+require 'rubygems'
+require 'neo4j/spatial'
+require 'neo4j/spatial/cmd'
+
+$args = Neo4j::Spatial::Cmd.args
+
+if $list === 'layers'
+  layers = Neo4j::Spatial::Layer.list
+  puts "Have #{layers.length} existing layers in the database:"
+  layers.each {|l| puts "\t#{l} (#{l.type_name})"}
+  puts
+  exit 0
+end
+
+if $help || $args.length < 2
+  puts <<-eos
+
+usage: ./osm_layer.rb <-D storage_path> <-l> <-h> layer layerspec <layerspecs>
+    -D  Use specified database location
+    -l  List existing database layers
+    -h  Display this help and exit
+  The layer should be a pre-existing OSM layer in the database created with OSM import.
+  The layerspec(s) are strings that are composed of multiple '-' or '.' separators.
+  Each pair in order is treated as a property-value pair to match when searching the
+  original layer for the new dynamic layer geometries.
+
+For example:
+  ./osm_layer.rb -D db croatia.osm highway highway-residential natural-water
+
+This will define three dynamic layers in the croation.osm dataset:
+  highway               all ways that have a 'highway' property
+  highway-residential   all ways that have 'highway'='residential'
+  natural-waterway      all ways that have 'natural'='waterway'
+
+eos
+  exit
+end
+
+$layer = Neo4j::Spatial::OSMLayer.new $args.shift
+
+if $layer.empty?
+  puts "No such layer: #{$layer}"
+end
+
+$args.each do |layerspec|
+  x = layerspec.split(/[\.-]/) << nil
+  x = x[0...(2*(x.length/2))] # allow only even number of entries
+  $layer.add_dynamic_layer Hash[*x]
+end

data/examples/test.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env jruby
+
+$: << 'lib'
+$: << '../lib'
+
+require 'rubygems'
+require 'neo4j/spatial'
+require 'fileutils'
+require 'amanzi/sld'
+
+#shp_importer.import '../neo4j-spatial/target/shp/sweden_coastline.shp'
+#png_exporter.export 'sweden_coastline'
+
+if false
+  FileUtils.rm_rf 'tmp'
+
+  osm_importer = Neo4j::Spatial::OSMImporter.new
+  osm_importer.import '../neo4j-spatial/map2.osm'
+  osm = Neo4j::Spatial::OSMLayer.new "map2.osm"
+  
+  osm.add_dynamic_layer
+  osm.add_dynamic_layer(:layer_name => 'test')
+  osm.add_dynamic_layer(:highway => nil)
+  osm.add_dynamic_layer(:highway => 'residential')
+  osm.add_dynamic_layer(:highway => :unclassified)
+
+else
+  osm = Neo4j::Spatial::OSMLayer.new "map2.osm"
+end
+
+puts "OSM Layer index should not be null: #{osm.index}"
+puts "OSM Layer index envelope should not be null: #{osm.index.layer_bounding_box}"
+#osm.index.debug_index_tree
+
+osm.layers.each do |l|
+  puts "Have layer: #{l.name}"
+  if l.respond_to? :query
+    puts "\t#{l.query}"
+  end
+end
+
+png_exporter = Neo4j::Spatial::ImageExporter.new
+#shp_importer = Neo4j::Spatial::ShapefileImporter.new
+
+# Define some common filtering rules
+major_highways = Proc.new do |f|  
+  f.op(:or) do |f|
+    f.property[:highway] = 'primary'
+    f.property[:highway] = 'motorway'
+  end
+end
+   
+highways = Proc.new do |f|
+  f.op(:or) do |f|
+    f.property[:highway] = 'primary'
+    f.property[:highway] = 'secondary'
+    f.property[:highway] = 'motorway'
+  end
+end
+
+main_roads = Proc.new do |f|
+  f.op(:or) do |f|
+    f.property[:highway] = 'primary'
+    f.property[:highway] = 'secondary'  
+    f.property[:highway] = 'tertiary'
+    f.property[:highway] = 'motorway'
+    f.property[:highway] = 'residential'
+  end
+end
+
+#png_exporter.export 'map2.osm', :sld => '../neo4j-spatial/neo.sld.xml'
+
+png_exporter.export 'highway' do |sld|
+  sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 3
+  sld.add_line_symbolizer :stroke => '#f0f0f0', :stroke_width => 2
+  sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 5 do |f|
+    main_roads.call f
+  end
+  sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 7 do |f|
+    highways.call f
+  end
+  sld.add_line_symbolizer :stroke => '#e0e0e0', :stroke_width => 3 do |f|
+    main_roads.call f
+  end
+  sld.add_line_symbolizer :stroke => '#f0f0a0', :stroke_width => 5 do |f|
+    highways.call f
+  end
+end
+
+#png_exporter.export 'highway-residential'
+#png_exporter.export 'highway-unclassified'
+

data/lib/neo4j/spatial/cmd.rb

@@ -0,0 +1,37 @@
+require 'neo4j'
+
+# Simple utility for parsing common command-line arguments specific to some command-line utilities
+module Neo4j
+  module Spatial
+    class Cmd
+      def self.args
+        @args=[]
+        while( arg = ARGV.shift ) do
+          if arg =~ /\-d/
+            $delete = true
+          elsif arg =~ /\-D/
+            path = ARGV.shift
+            if path && path.length > 0
+              Neo4j::Config[:storage_path] = path
+            else
+              puts "Invalid database location: #{path}"
+            end
+          elsif arg =~ /\-E/
+            $export = ARGV.shift
+          elsif arg =~ /\-F/
+            $format = ARGV.shift
+          elsif arg =~ /\-L/
+            $list = ARGV.shift
+          elsif arg =~ /\-l/
+            $list = 'layers'
+          elsif arg =~ /\-h/
+            $help = true
+          else
+            @args << arg
+          end
+        end
+        @args
+      end
+    end
+  end
+end

data/lib/neo4j/spatial/database.rb

@@ -0,0 +1,85 @@
+# This file includes two modules for working with the database in a spatial way:
+# - an extension to the Neo4j::Database module allowing re-opening the database with the BatchInserter API
+# - a Neo4::Spatial::Database module to be including in classes that need access to sptail extensions on the database
+
+module Neo4j
+
+  # We extend the normal Neo4j::Database module with the ability to switch between normal and batch-inserter modes
+  class Database
+    def shutdown
+      if @running
+        #puts "Shutting down database"
+        if @batch.nil?
+          #puts "Unregistering event handler"
+          @graph.unregister_transaction_event_handler(@event_handler) unless read_only?
+          @event_handler.neo4j_shutdown(self)
+        end
+        @graph.shutdown
+        @graph  = nil
+        @batch  = nil
+        @lucene = nil
+        @spatial = nil
+        @running = false
+      end
+    end
+    def restart_batch_inserter
+      shutdown
+      @running = true
+      @batch = org.neo4j.kernel.impl.batchinsert.BatchInserterImpl.new(Config[:storage_path])
+      @graph = @batch.graph_db_service
+      @batch
+    end
+    def restart_normal_database
+      shutdown
+      start
+    end
+    def is_batch?
+      @batch
+    end
+    def spatial
+      @spatial ||= org.neo4j.gis.spatial.SpatialDatabaseService.new(@graph)
+    end
+  end
+
+  module Spatial
+
+    # This module is to be included in classes that wish to have instance level access to the database and spatial database extensions
+    module Database
+      def database(options={})
+        options[:dbpath] ||= Neo4j::Config[:storage_path]
+        if Neo4j.running? && Neo4j::Config[:storage_path] != options[:dbpath]
+          raise "Database already running at different location: #{Neo4j::Config[:storage_path]} != #{options[:dbpath]}"
+        end
+        Neo4j::Config[:storage_path] = options[:dbpath]
+        @commit = options[:commit] || 1000
+        normal_database
+      end
+      def spatial
+        @spatial ||= @db.spatial
+      end
+      def list_all
+        spatial.layer_names
+      end
+      def batch_inserter
+        unless @bi
+          puts "Getting batch inserter database API access"
+          @spatial = nil
+          @bi = @db.restart_batch_inserter
+        end
+        @bi
+      end
+      def normal_database
+        if @db && @db.is_batch?
+          puts "Switch off BatchInserter access"
+          @db.restart_normal_database
+          @spatial = nil
+          @bi = nil
+        end
+        @db ||= Neo4j.started_db
+        @db.graph
+      end
+    end
+
+  end
+
+end

data/lib/neo4j/spatial/image.rb

@@ -0,0 +1,54 @@
+require 'neo4j/spatial/listener'
+require 'neo4j/spatial/database'
+require 'tempfile'
+
+module Neo4j
+  module Spatial
+    class ImageExporter
+      include Database
+      def initialize(options={})
+        default(options)
+        database(options)
+        @exporter = org.neo4j.gis.spatial.geotools.data.StyledImageExporter.new(@db.graph)
+        @exporter.setExportDir(options[:dir])
+        @exporter.setZoom(options[:zoom])
+        @exporter.setOffset((options[:offset_x] || options[:offset]).to_f, (options[:offset_y] || options[:offset]).to_f)
+        @exporter.setSize(options[:width], options[:height])
+      end
+      def default(options)
+        options[:dir] ||= "target/export"
+        options[:zoom] ||= 3.0
+        options[:offset] ||= 0.0
+        options[:width] ||= 600
+        options[:height] ||= 400
+      end
+      def export(layer_name,options={})
+        @layer_name = layer_name
+        options[:path] ||= layer_name+'.png'
+        if block_given?
+          puts "block is given"
+        end
+        if options[:sld].nil?
+          puts "SLD nil"
+        end
+        if options[:sld].nil? && block_given?
+          Tempfile.open 'neo4j-spatial-sld' do |out|
+            options[:sld] = out.path
+            sld = Amanzi::SLD::Document.new layer_name
+            yield sld
+            out.puts sld.to_xml :tab => '  '
+          end
+        end
+        options[:sld] ||= 'neo.sld.xml'
+        puts "Exporting #{layer_name} to #{options[:path]} using style #{options[:sld]}"
+        @exporter.saveLayerImage(layer_name, options[:sld], options[:path])
+      end
+      def format
+        "PNG"
+      end
+      def to_s
+        @layer_name || format
+      end
+    end
+  end
+end

data/lib/neo4j/spatial/layer.rb

@@ -0,0 +1,60 @@
+require 'neo4j/spatial/database'
+
+java_import org.neo4j.gis.spatial.Constants
+java_import org.neo4j.gis.spatial.SpatialDatabaseService
+
+module Neo4j
+  module Spatial
+    
+    # This class wraps the spatial database layer class and provides some utilities for
+    # wrapping some layer actions normally taken by the SpatialDatabaseService, liking finding layers 
+    class Layer
+      TYPES = [:unknown, :point, :linestring, :polygon, :multipoint, :multilinestring, :multipolygon]
+      include Database
+      attr_reader :layer_name, :layer
+      def initialize(layer_name,options={})
+        database(options)
+        @layer_name = layer_name
+        @layer = spatial.getLayer(@layer_name)
+        unless @layer
+          if options[:encoder] && options[:type]
+            @layer = spatial.getOrCreateLayer(@layer_name, options[:encoder], options[:type])
+          elsif options[:x] && options[:y]
+            @layer = spatial.getOrCreatePointLayer(@layer_name, options[:x].to_s, options[:y].to_s)
+          else
+            @layer = spatial.getOrCreateDefaultLayer(@layer_name)
+          end
+        end
+      end
+      def respond_to?(symbol)
+        symbol == :empty? || @layer.respond_to?(symbol)
+      end
+      def method_missing(symbol,*args,&block)
+        @layer.send symbol, *args, &block
+      end
+      def empty?
+        @layer.index.is_empty
+      end
+      def to_s
+        @layer.name
+      end
+      def type_name
+        @layer.class.to_s.downcase.gsub(/.*[\.\:](\w+)layer.*/){|m| $1}
+      end
+      def self.names
+        Neo4j.started_db.spatial.layer_names
+      end
+      def self.list
+        Neo4j.started_db.spatial.layer_names.map do |name|
+          Layer.new(name)
+        end
+      end
+      def self.exist? name
+        self.names.grep(name).length > 0
+      end
+      def self.find name
+        exist?(name) && Layer.new(name)
+      end
+    end
+  end
+end

data/lib/neo4j/spatial/listener.rb

@@ -0,0 +1,29 @@
+# This file defines a mixin to be used by classes that want to act as listners implementing the org.neo4j.gis.spatial.Listener interface
+
+module Neo4j
+  module Spatial
+    module Listener
+      include org.neo4j.gis.spatial.Listener
+      def initialize(dbpath=nil)
+        @work = 100
+        @worked = 0
+      end
+      def begin(units_of_work)
+        @work = units_of_work
+        @work = 100 if(@work<1)
+        @worked = 0
+      end
+      def worked(worked_since_last_notification)
+        @worked += worked_since_last_notification
+        progress
+      end
+      def done
+        @worked = @work
+        progress
+      end
+      def progress
+        puts "#{100*@worked/@work}% #{self}"
+      end
+    end
+  end
+end

data/lib/neo4j/spatial/osm.rb

@@ -0,0 +1,52 @@
+require 'neo4j/spatial/listener'
+require 'neo4j/spatial/database'
+
+java_import org.neo4j.gis.spatial.Constants
+java_import org.neo4j.gis.spatial.SpatialDatabaseService
+java_import org.neo4j.gis.spatial.osm.OSMGeometryEncoder
+
+module Neo4j
+  module Spatial
+    class OSMLayer < Layer
+      def initialize(layer_name,options={})
+        super(layer_name, options.merge({
+          :type => org.neo4j.gis.spatial.osm.OSMLayer,
+          :encoder => OSMGeometryEncoder
+        }))
+      end
+      def add_dynamic_layer(options={})
+        gtype = (options.delete(:gtype) || Constants.GTYPE_LINESTRING).to_i
+        name ||= options.delete(:layer_name) ||
+          !options.empty? && options.to_a.flatten.compact.join('-') ||
+          SpatialDatabaseService.convertGeometryTypeToName(gtype)
+        if list.grep(name).length > 0
+          puts "We already have a dynamic layer called '#{name}'"
+        else
+          puts "Creating new dynamic layer '#{name}'[GType:#{TYPES[gtype]}]: #{options.inspect}"
+          layer.add_dynamic_layer_on_way_tags(name.to_s, gtype, java.util.HashMap.new(options))
+        end
+      end
+      def list
+        @layer.layer_names
+      end
+    end
+    class OSMImporter
+      include Listener
+      include Database
+      def initialize(options={})
+        database(options)
+      end
+      def import(osm_path,layer_name=nil)
+        @osm_path = osm_path
+        layer_name ||= osm_path.split(/[\\\/]+/)[-1]
+        puts "\n=== Loading layer #{layer_name} from #{osm_path} ==="
+        @importer = org.neo4j.gis.spatial.osm.OSMImporter.new(layer_name)
+        @importer.import_file batch_inserter, @osm_path
+        @importer.re_index normal_database, @commit
+      end
+      def to_s
+        @osm_path.to_s
+      end
+    end
+  end
+end

data/lib/neo4j/spatial/shapefile.rb

@@ -0,0 +1,50 @@
+require 'neo4j/spatial/listener'
+require 'neo4j/spatial/database'
+
+# Utilities for importing and exporting ESRI Shapefile data
+
+module Neo4j
+  module Spatial
+    
+    # This class facilitates importing datasets in the ESRI Shapefile format
+    class ShapefileImporter
+      include Listener
+      include Database
+      def initialize(options={})
+        database(options)
+        @importer = org.neo4j.gis.spatial.ShapefileImporter.new(@db.graph, self, @commit)
+      end
+      def import(shp_path,layer_name=nil)
+        @shp_path = shp_path
+        layer_name ||= shp_path.split(/[\\\/]+/)[-1].gsub(/\.\w+$/,'')
+        @importer.import_file @shp_path, layer_name
+      end
+      def to_s
+        @shp_path.to_s
+      end
+    end
+
+    # This class facilitates importing datasets in the ESRI Shapefile format
+    class ShapefileExporter
+      include Database
+      def initialize(options={})
+        options[:dir] ||= "target/export"
+        database(options)
+        @exporter = org.neo4j.gis.spatial.ShapefileExporter.new(@db.graph)
+        @exporter.setExportDir(options[:dir])
+      end
+      def export(layer_name,options={})
+        @layer_name = layer_name
+        options[:path] ||= layer_name+'.shp'
+        puts "Exporting #{layer_name} to #{options[:path]}"
+        @exporter.exportLayer(layer_name, options[:path])
+      end
+      def format
+        "ESRI Shapefile"
+      end
+      def to_s
+        @layer_name || format
+      end
+    end
+  end
+end

data/lib/neo4j/spatial/version.rb

@@ -0,0 +1,5 @@
+module Neo4j
+  module Spatial
+    VERSION = "0.0.1"
+  end
+end

data/lib/neo4j/spatial.rb

@@ -0,0 +1,56 @@
+include Java
+
+# Some paths useful in development environment
+$LOAD_PATH << '../amanzi-sld/lib'
+$LOAD_PATH << '../../amanzi-sld/lib'
+$CLASSPATH << '../neo4j-spatial/target/classes'
+$CLASSPATH << '../../neo4j-spatial/target/classes'
+
+require 'neo4j'
+begin
+  require 'amanzi/sld'
+rescue LoadError
+end
+
+require 'neo4j/spatial/jars/neo4j-spatial-0.3-SNAPSHOT.jar'
+require 'neo4j/spatial/jars/json-simple-1.1.jar'
+require 'neo4j/spatial/jars/log4j-1.2.14.jar'
+
+# Geotools main API and Geometry support
+require 'neo4j/spatial/jars/gt-main/xercesImpl-2.4.0.jar'
+require 'neo4j/spatial/jars/gt-main/gt-api-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-main/jdom-1.0.jar'
+require 'neo4j/spatial/jars/gt-main/jts-1.11.jar'
+require 'neo4j/spatial/jars/gt-main/gt-main-2.7-M3.jar'
+
+# Geotools support for rendering, used in examples for writing maps to PNG
+require 'neo4j/spatial/jars/gt-render/jai_codec-1.1.3.jar'
+require 'neo4j/spatial/jars/gt-render/imageio-ext-tiff-1.0.7.jar'
+require 'neo4j/spatial/jars/gt-render/gt-render-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-render/gt-coverage-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-render/gt-cql-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-render/imageio-ext-utilities-1.0.7.jar'
+require 'neo4j/spatial/jars/gt-render/jai_core-1.1.3.jar'
+require 'neo4j/spatial/jars/gt-render/jai_imageio-1.1.jar'
+
+# Geotools Shapefile support for some utilties for reading/writing shapefiles
+require 'neo4j/spatial/jars/gt-shapefile/jsr-275-1.0-beta-2.jar'
+require 'neo4j/spatial/jars/gt-shapefile/geoapi-2.3-M1.jar'
+require 'neo4j/spatial/jars/gt-shapefile/gt-data-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-shapefile/vecmath-1.3.2.jar'
+require 'neo4j/spatial/jars/gt-shapefile/gt-shapefile-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-shapefile/commons-pool-1.5.4.jar'
+require 'neo4j/spatial/jars/gt-shapefile/gt-metadata-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-shapefile/gt-referencing-2.7-M3.jar'
+require 'neo4j/spatial/jars/gt-shapefile/geoapi-pending-2.3-M1.jar'
+
+# Some other possibile dependencies found in the java project
+#require 'neo4j/spatial/jars/not-needed/commons-logging-1.1.1.jar'
+#require 'neo4j/spatial/jars/not-needed/junit-4.4.jar'
+#require 'neo4j/spatial/jars/not-needed/xml-apis-1.0.b2.jar'
+
+require 'neo4j/spatial/database.rb'
+require 'neo4j/spatial/layer.rb'
+require 'neo4j/spatial/shapefile.rb'
+require 'neo4j/spatial/osm.rb'
+require 'neo4j/spatial/image.rb'