neo4j-spatial 0.0.1-java

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.0.1 / 2010-12-09
+* First release based on trivial wrapper on Neo4j Spatial 0.3-SNAPSHOT
+* Depends on Neo4j.rb 1.0.0 (beta), to get the required Neo4j-1.2 jars

data/CONTRIBUTORS

@@ -0,0 +1,5 @@
+Maintainer:
+  Craig Taverner <craig at amanzi dot com>
+
+Contributors:
+* 

data/Gemfile

@@ -0,0 +1,15 @@
+source :gemcutter
+
+gemspec
+
+group 'test' do
+  gem "rake", ">= 0.8.7"
+  gem "rdoc", ">= 2.5.10"
+  gem "horo", ">= 1.0.2"
+  gem "rspec", ">= 2.0.0"
+  gem "test-unit"
+end
+
+#gem 'ruby-debug-base19' if RUBY_VERSION.include? "1.9"
+#gem 'ruby-debug-base' if RUBY_VERSION.include? "1.8"
+#gem "ruby-debug-ide"

data/README.rdoc

@@ -0,0 +1,55 @@
+== Welcome to neo4j-spatial.rb
+
+Neo4j is a graph database for Java, Neo4j.rb is a graph database for JRuby using Neo4j internally. Neo4j-spatial.rb is a wrapper on Neo4j.rb that includes all the Java dependencies to enable spatial analysis, and includes some Ruby wrappers to access the spatial utilities.
+
+For more information on the underlying components refer to:
+* {Neo4J}[http://www.neo4j.org] - for persistence and traversal of the graph
+* {Neo4J.rb}[http://github.com/andreasronge/neo4j] - for Ruby API to Neo4j
+* {Neo4j-Spatial}[http://github.com/neo4j/neo4j-spatial] - for loading, indexing and analysing spatial data
+
+=== Why Neo4j-Spatial.rb ?
+
+When we wrote Neo4j-spatial we found that while it had many capabilities, most users did not know about them. The lack of articles, blogs and examples made the code a little unapproachable. This Ruby wrapper was originally written to support writing blogs about some of the interesting use cases that are possible with Neo4j-Spatial, but the decision to base it on Andreas Ronges excellent Neo4j.rb library also means that it can be used in a much wider context, including Rails application.
+
+=== Documentation
+
+.. to be done ..
+
+=== Installation
+
+Two options:
+* As a RubyGem: jruby -S gem install neo4j-spatial
+* From source: git clone git@github.com:craigtaverner/neo4j-spatial.rb.git
+
+Take note that neo4j-spatial.rb requires that you install the neo4j gem for database access, and optionally the amanzi-sld gem (for advanced styling of the PNG exports). If you install neo4j-spatial as a rubygem, you should get these dependencies automatically, otherwise be sure to install them before running the examples below.
+
+=== Some Examples
+
+.. to be done ..
+(or see the code in the command-line utilities described below for examples)
+
+=== Command-line utilities
+
+The examples directory includes a few sample Ruby scripts for various import/export tasks, as well as some sample OSM data to test one. Consider the following run through:
+
+  git clone git@github.com:craigtaverner/neo4j-spatial.rb.git
+  cd neo4j-spatial.rb/examples
+  jruby osm_import.rb map2.osm
+  jruby osm_layer.rb map2.osm highway highway-residential waterway natural natural-water
+  jruby osm_layer.rb -l
+  jruby export_layer.rb highway-residential
+  jruby export_layer.rb -F shp highway-residential natural
+
+Then take a look in the examples/target/export directory for the PNG and SHP files generated. Run each of the three utility commands with no arguments, or with -h, to see what options are available.
+
+=== Contributing
+
+Have you found a bug, need help or have a patch ?
+Just clone neo4j-spatial.rb and send me a pull request or email me.
+Do you need help - mail the neo4j or neo4j.rb mailing lists.
+
+=== License
+
+* Neo4j and Neo4j-Spatial - Dual free software/commercial license, see http://neo4j.org/
+* Neo4j.rb - MIT, see the LICENSE file http://github.com/andreasronge/neo4j/tree/master/LICENSE.
+* Lucene -  Apache, see http://lucene.apache.org/java/docs/features.html

data/examples/export_layer.rb

@@ -0,0 +1,54 @@
+#!/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 < 1
+  puts <<-eos
+
+usage: ./export_layer.rb <-D storage_path> <-F format> <-E dir> <-l> <-h> layer <layers>
+    -D  Use specified database location
+    -F  Use specified export format (png, shp)
+    -E  Use specified export directory path (default '.')
+    -l  List existing database layers first
+    -h  Display this help and exit
+  The layer(s) should be pre-existing layers (including dynamic layers) in the database.
+  Supported formats are 'shp' for ESRI Shapefile and 'png' for images.
+
+For example:
+  ./export_layer.rb -D db -E exports -F png croatia.osm highway highway-residential natural-water
+
+This will export four previously defined layers to png format files in the 'exports' directory.
+
+eos
+  exit
+end
+
+if $format.to_s === 'shp'
+  $exporter = Neo4j::Spatial::ShapefileExporter.new :dir => $export
+else
+  $exporter = Neo4j::Spatial::ImageExporter.new :dir => $export
+end
+
+puts "Exporting #{$args.length} layers to #{$exporter.format}"
+
+$args.each do |layer|
+  l = Neo4j::Spatial::Layer.find layer
+  puts "Exporting #{l} (#{l.type_name}) - #{l.index.layer_bounding_box}"
+  $exporter.export l.name
+end