geohydra 0.3.1 → 0.3.3

data/lib/geohydra/workflow/gisAssemblyWF.rb

@@ -0,0 +1,109 @@
+module GeoHydra
+  module GisAssemblyWF
+
+    class RegisterDruidTask < ManualTask; end
+    
+    class AuthorMetadataTask < ManualTask; end
+    
+    class ApproveMetadataTask < ManualTask; end
+    
+    class WrangleDataTask < ManualTask; end
+    
+    class ApproveDataTask < ManualTask; end
+    
+    class NormalizeDataTask < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class PackageDataTask
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class FinishDataTask < NoopTask; end
+    
+    class ExtractThumbnailTask < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class ExtractIso19139Task < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class GenerateGeoMetadataTask < Task
+      def perform(data)
+        initialize(data)
+        isoFn = File.join(druid.temp_dir, 'iso19139.xml')
+        fcFn = File.join(druid.temp_dir, 'iso19110.xml')
+        geoFn = File.join(druid.metadata_dir, 'geoMetadata.xml')
+        log_debug({:isoFn => isoFn, :fcFn => fcFn, :geoFn => geoFn, :flags => flags})
+        
+        unless FileUtils.uptodate?(geoFn, [isoFn, fcFn])
+          isoXml = Nokogiri::XML(File.read(isoFn))
+          fcXml = Nokogiri::XML(File.read(fcFn))
+          log_verbose("Generating geoMetadata: #{geoFn} <- #{isoFn}, #{fcFn}")
+          xml = GeoHydra::Transform.to_geoMetadataDS(isoXml, fcXml, { 'purl' => to_purl}) 
+          File.open(geoFn, 'w') {|f| f << xml.to_xml(:indent => 2) }
+        end
+        'SUCCESS'
+      end
+    end
+
+    class GenerateModsTask < Task
+      def perform(data)
+        initialize(data)
+        geoFn = File.join(druid.metadata_dir, 'geoMetadata.xml')
+        modsFn = File.join(druid.metadata_dir, 'descMetadata.xml')
+        log_debug({:geoFn => geoFn, :modsFn => modsFn, :flags => flags})
+        
+        unless FileUtils.uptodate?(modsFn, [geoFn])
+          # MODS from GeoMetadataDS
+          geoMetadata = Dor::GeoMetadataDS.from_xml File.read(geoFn)
+          geoMetadata.geometryType = data[:geometryType] || 'Polygon'
+          geoMetadata.zipName = 'data.zip'
+          geoMetadata.purl = to_purl
+          
+          log_debug({:geoMetadata => geoMetadata.ng_xml})
+          File.open(modsFn, 'w') { |f| f << geoMetadata.to_mods.to_xml(:index => 2) }
+        end
+        'SUCCESS'
+      end
+    end
+
+    class AssignPlacenamesTask < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class FinishMetadataTask < NoopTask; end
+    
+    class GenerateContentMetadataTask < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class FinishGisAssemblyPipeline < NoopTask; end
+    
+    class StartAssemblyWorkflowTask < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+    class StartDeliveryWorkflowTask < Task
+      def perform(data)
+        raise NotImplementedError
+      end
+    end
+    
+  end
+end

data/lib/geohydra/workflow/gisAssemblyWF.xml

@@ -0,0 +1,85 @@
+<?xml version="1.0"?>
+<workflow-def id="gisAssemblyWF" repository="dor">
+  <process name="start-gis-assembly-pipeline" sequence="1" status="completed">
+    <label>Initiate assembly pipeline for the object</label>
+  </process>
+  <process name="register-druid" sequence="2">
+    <prereq>start-gis-assembly-pipeline</prereq>
+    <label>Ensure proper registration of druid, source ID, and label</label>
+  </process>
+  <process name="author-metadata" sequence="3">
+    <prereq>register-druid</prereq>
+    <label>Author metadata using ArcCatalog</label>
+  </process>
+  <process name="approve-metadata" sequence="4">
+    <prereq>author-metadata</prereq>
+    <label>Approve metadata quality and release for workflow pipeline</label>
+  </process>
+  <process name="wrangle-data" sequence="5">
+    <prereq>register-druid</prereq>
+    <prereq>approve-metadata</prereq><!-- XXX: force linear -->
+    <label>Wrangle the data into the digital work</label>
+  </process>
+  <process name="approve-data" sequence="6">
+    <prereq>wrangle-data</prereq>
+    <label>Approve data quality for digital work and release for workflow pipeline</label>
+  </process>
+  <process name="normalize-data" sequence="7">
+    <prereq>approve-data</prereq>
+    <label>Reproject the data into common SRS projection and/or file format</label>
+  </process>  
+  <process name="package-data" sequence="8">
+    <prereq>normalize-data</prereq>
+    <label>Package the digital work and derivative data files</label>
+  </process>
+  <process name="finish-data" sequence="9">
+    <prereq>package-data</prereq>
+    <label>Finalize the data preparation</label>
+  </process>  
+  <process name="extract-thumbnail" sequence="10">
+    <prereq>approve-metadata</prereq>
+    <prereq>finish-data</prereq><!-- XXX: force linear -->
+    <label>Extract thumbnail preview</label>
+  </process>
+  <process name="extract-iso19139" sequence="11">
+    <prereq>approve-metadata</prereq>
+    <prereq>finish-data</prereq> <!-- requires shapefile -->
+    <prereq>extract-thumbnail</prereq><!-- XXX: force linear -->
+    <label>Extract ISO 19139 metadata from ArcCatalog</label>
+  </process>
+  <process name="generate-geo-metadata" sequence="12">
+    <prereq>extract-iso19139</prereq>
+    <label>Convert ISO 19139 metadata into geoMetadata</label>
+  </process>
+  <process name="generate-mods" sequence="13">
+    <prereq>generate-geoMetadata</prereq>
+    <label>Convert geoMetadata into MODS</label>
+  </process>
+  <process name="assign-placenames" sequence="14">
+    <prereq>generate-mods</prereq>
+    <label>Insert linked data into MODS record from gazetteer</label>
+  </process>
+  <process name="finish-metadata" sequence="15">
+    <prereq>extract-thumbnail</prereq>
+    <prereq>assign-placenames</prereq>
+    <label>Finalize the data preparation</label>
+  </process>  
+  <process name="generate-content-metadata" sequence="16">
+    <prereq>finish-metadata</prereq>
+    <prereq>finish-data</prereq>
+    <label>Generate contentMetadata manifest</label>
+  </process>  
+  <process name="finish-gis-assembly-pipeline" sequence="17">
+    <prereq>generate-content-metadata</prereq>
+    <label>Finalize assembly pipeline to prepare for assembly/delivery/discovery</label>
+  </process>
+  <process name="start-assembly-workflow" sequence="18">
+    <prereq>finish-gis-assembly-pipeline</prereq>
+    <label>Kickstart the core assembly workflow at assemblyWF</label>
+  </process>
+  <process name="start-delivery-workflow" sequence="19">
+    <prereq>finish-gis-assembly-pipeline</prereq>
+    <prereq>start-assembly-workflow</prereq><!-- XXX: force linear -->
+    <label>Kickstart the GIS delivery workflow at gisDeliveryWF</label>
+  </process>
+</workflow-def>

data/lib/geohydra/workflow/gisDeliveryWF.rb

@@ -0,0 +1,33 @@
+module GeoHydra
+  module GisDeliveryWF
+
+    class StartGisDeliveryPipelineTask < NoopTask; end
+    
+    class LoadVectorTask < Task
+      
+    end
+    
+    class LoadRasterTask < Task
+      
+    end
+    
+    class LoadGeoserverTask < Task
+      
+    end
+    
+    class LoadGeowebcacheTask < Task
+      
+    end
+    
+    class SeedGeowebcacheTask < Task
+      
+    end
+    
+    class FinishGisDeliveryPipelineTask < NoopTask; end
+    
+    class StartGisDiscoveryWorkflowTask < Task
+      
+    end
+      
+  end
+end

data/lib/geohydra/workflow/gisDeliveryWF.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<workflow-def id="gisDeliveryWF" repository="dor">
+  <process name="start-gis-delivery-pipeline" sequence="1" status="completed">
+    <label>Initiate delivery pipeline for the object</label>
+  </process>  
+  <process name="load-vector" sequence="2">
+    <prereq>start-gis-delivery-pipeline</prereq>
+    <label>Load vector data into PostGIS database</label>
+  </process>  
+  <process name="load-raster" sequence="3">
+    <prereq>start-delivery-pipeline</prereq>
+    <prereq>load-vector</prereq><!-- XXX: force linear -->
+    <label>Load raster into GeoTIFF data store</label>
+  </process>  
+  <process name="load-geoserver" sequence="4">
+    <prereq>load-vector</prereq>
+    <prereq>load-raster</prereq>
+    <label>Load layers into GeoServer</label>
+  </process>
+  <process name="load-geowebcache" sequence="5">
+    <prereq>load-geoserver</prereq>
+    <label>Load layers into GeoWebCache</label>
+  </process>
+  <process name="seed-geowebcache" sequence="6">
+    <prereq>load-geowebcache</prereq>
+    <label>Generate tiles for GeoWebCache</label>
+  </process>
+  <process name="finish-gis-delivery-pipeline" sequence="7">
+    <prereq>seed-geowebcache</prereq>
+    <label>Finalize delivery pipeline for the object</label>
+  </process> 
+  <process name="start-gis-discovery-workflow" sequence="8">
+    <prereq>finish-gis-delivery-pipeline</prereq>
+    <label>Kickstart GIS discovery workflow with gisDiscoveryWF</label>
+  </process> 
+</workflow-def>

data/lib/geohydra/workflow/gisDiscoveryWF.rb

@@ -0,0 +1,55 @@
+module GeoHydra
+  module GisDiscoveryWF
+    class GenerateSolr < Task
+      def perform_solr(app)
+        modsFn = File.join(druid.metadata_dir, 'descMetadata.xml')
+        solrFn = File.join(druid.temp_dir, "#{app}Solr.xml")
+        log_debug({:modsFn => modsFn, :solrFn => solrFn, :flags => flags})
+        
+        unless FileUtils.uptodate?(solrFn, [modsFn])
+          # Solr document from descMetadataDS
+          cmd = [ 'xsltproc',
+                  "--stringparam geoserver_root '#{flags[:geoserver]}'",
+                  "--stringparam purl '#{to_purl}'",
+                  "--output '#{solrFn}'",
+                  "'#{File.expand_path(File.dirname(__FILE__) + '/../mods2#{app}.xsl')}'",
+                  "'#{modsFn}'"
+                  ].join(' ')
+          log_debug({:cmd => cmd})
+          system(cmd)
+        end
+        'SUCCESS'
+      end      
+      
+    end
+
+    class StartGisDiscoveryPipelineTask < NoopTask; end
+    
+    class GenerateOgpTask < GenerateSolr
+      def perform(data)
+        initialize(data)
+        perform_solr('ogp')
+      end
+      
+    end
+    
+    class LoadOgpTask < Task
+
+    end
+    
+    class GenerateGeosearchTask < Task
+      def perform(data)
+        initialize(data)
+        perform_solr('geoblacklight')
+      end
+    end
+    
+    class LoadGeosearchTask < Task
+      
+    end
+
+    class FinishGisDiscoveryPipeline < Task
+      
+    end
+  end
+end

data/lib/geohydra/workflow/gisDiscoveryWF.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<workflow-def id="gisDiscoveryWF" repository="dor">
+  <process name="start-gis-discovery-pipeline" sequence="1" status="completed">
+    <label>Initiate GIS discovery pipeline for the object</label>
+  </process>  
+  <process name="generate-ogp" sequence="2">
+    <prereq>start-gis-discovery-pipeline</prereq>
+    <label>Generate Solr document for OpenGeoPortal</label>
+  </process>
+  <process name="load-ogp" sequence="3">
+    <prereq>generate-ogp</prereq>
+    <label>Load Solr document into OpenGeoPortal</label>
+  </process>  
+  <process name="generate-geosearch" sequence="4">
+    <prereq>start-gis-discovery-pipeline</prereq>
+    <prereq>load-ogp</prereq><!-- XXX: force linear -->
+    <label>Generate Solr document for GeoSearch</label>
+  </process>
+  <process name="load-geosearch" sequence="5">
+    <prereq>generate-geosearch</prereq>
+    <label>Load Solr document into GeoSearch</label>
+  </process>
+  <process name="finish-gis-discovery-pipeline" sequence="6">
+    <prereq>load-ogp</prereq>
+    <prereq>load-geosearch</prereq>
+    <label>Finalize GIS discovery pipeline for the object</label>
+  </process> 
+</workflow-def>

data/lib/geohydra/workflow/task.rb

@@ -0,0 +1,82 @@
+require 'druid-tools'
+
+module GeoHydra
+  class Task
+    STATUS = %w{HOLD READY RUNNING DEFERRED ERROR COMPLETED}
+    # @param [String] status 
+    # @return [Boolean] true if the given status is one of the valid Task.STATUS values
+    def valid_status? status
+      STATUS.include? status.upcase
+    end
+    
+    attr_accessor :druid, :flags
+
+    def initialize(data = {})
+      @flags = {}
+      @flags[:debug] = data[:debug] || false
+      @flags[:geoserver] = data[:geoserver] || GeoHydra::Config.ogp.geoserver || 'http://127.0.0.1:8080/geoserver'
+      @flags[:purl] = data[:purl] || GeoHydra::Config.ogp.purl || 'http://purl.stanford.edu'
+      @flags[:solr] = data[:solr] || GeoHydra::Config.ogp.solr || 'http://127.0.0.1:8983/solr'
+      @flags[:stagedir] = data[:stagedir] || GeoHydra::Config.geohydra.stage || 'stage'
+      @flags[:tmpdir] = data[:tmpdir] || GeoHydra::Config.geohydra.tmpdir || 'tmp'
+      @flags[:verbose] = data[:verbose] || false
+      @flags[:workspacedir] = data[:workspacedir] || GeoHydra::Config.geohydra.workspace || 'workspace'
+      
+      @druid = nil
+      @druid = _setup_druid(data[:druid]) unless data[:druid].nil?
+    end
+    
+    # Perform the task
+    # @param [Hash] data
+    # @return [String] one of the `Task.STATUS` values
+    def perform(data = {})
+      raise NotImplementedError, 'abstract method'
+    end
+
+    # @param [String] druid `aa111bb2222`
+    def druid= druid
+      _init_druid druid
+    end
+    
+    # Converts the current @druid into a PURL
+    # @return [String] `http://purl.stanford.edu/aa111bb2222`
+    def to_purl
+      File.join(flags[:purl], @druid.id)
+    end
+    
+    def log_info(args)
+      puts args
+    end
+
+    def log_verbose(args)
+      ap({:verbose => args}) if flags[:verbose]
+    end
+
+    def log_debug(args)
+      ap({:debug => args}) if flags[:debug]
+    end
+
+    def log_error(args)
+      ap({:error => args})
+    end
+    
+    private
+    def _setup_druid s
+      druid = DruidTools::Druid.new(s, flags[:workspacedir])
+      raise ArgumentError if druid.nil? or not DruidTools::Druid.valid?(druid.druid)
+      druid
+    end
+  end
+  
+  class NoopTask < Task
+    def perform(data)
+      'COMPLETED'
+    end
+  end
+
+  class ManualTask < Task
+    def perform(data)
+      'HOLD'
+    end
+  end
+end

data/ogp/README.md

@@ -0,0 +1,350 @@
+{toc:maxLevel=2}
+
+h1. Solr schema
+
+The schema XML is on Github here: https://github.com/sul-dlss/geohydra/blob/master/solr/kurma-app-test/conf/schema.xml.
+
+h2. Primary key
+
+* *uuid*: Unique Identifier. Examples:
+** [http://purl.stanford.edu/vr593vj7147],
+** [http://ark.cdlib.org/ark:/28722/bk0012h535q],
+** urn:geodata.tufts.edu:Tufts.CambridgeGrid100_04.
+
+h2. Dublin Core
+
+{note}
+See the [Dublin Core Elements Guide|http://dublincore.org/documents/dcmi-terms/] for semantic descriptions of all of these fields. We're using both DC Elements and DC Terms
+{note}
+
+* *dct_spatial_sm*: Coverage, placenames. Multiple values allowed. Example: "Paris, France".
+* *dct_temporal_sm*: Coverage, years. Multiple values allowed. Example: "2010".
+* *dc_creator_sm*: Author(s). Example: "Washington, George".
+* *dct_issued_dt*: Date in Solr syntax. Example: "2001-01-01T00:00:00Z".
+* *dc_description_s*: Description.
+* *dc_format_s*: File format (not MIME types). Valid values:
+** "Shapefile"
+** "GeoTIFF"
+* *dc_identifier_s*: Unique identifier. Same as UUID.
+* *dc_language_s*: Language. Example: "English".
+* *dc_publisher_s*: Publisher. Example: "ML InfoMap (Firm)".
+* *dct_references_sm*: URLs to referenced resources. Used scheme and url parameters. scheme values are based on [CatInterop|https://github.com/OSGeo/Cat-Interop/blob/master/link_types.csv] Multiple values allowed. Example:
+scheme="urn:ogc:serviceType:WebFeatureService" url="http://geowebservices-restricted.stanford.edu/geoserver
+/wfs"
+* *dc_rights_s*: Rights for access. Valid values:
+** "Restricted"
+** "Public"
+* *dct_provenance_s*: Source institution: Examples:
+** Berkeley
+** Harvard
+** MassGIS
+** MIT
+** Stanford
+** Tufts
+* *dc_subject_sm*: Subject. Multiple values allowed. Example: "Human settlements", "Census".
+* *dc_title_s*: Title.
+* *dc_type_s*: Resource type. dc:type=Dataset for georectified images, dc:type=Image for digitaized, non-georectified images, or dc:type=PhysicalObject for paper maps (no digitization).
+* *dct_isPartOf_sm*: Collection to which the layer belongs.
+
+h2. GeoRSS metadata
+
+* *georss_point_s*: Point representation for layer -- i.e., centroid?
+* *georss_box_s*: Bounding box as maximum values for S W N E. Example: "12.62309 76.76 19.91705 84.76618"
+* *georss_polygon_s*: Shape of the layer as a Polygon.
+Example: "n w n e s e s w n w"
+
+h2. Layer-specific metadata
+
+* *layer_slug_s*. Unique identifier visible to the user, used for Permalinks.
+* Example: stanford-vr593vj7147.
+* *layer_id_s*. The complete identifier for the WMS/WFS/WCS layer.
+Example: "druid:vr593vj7147",
+* *layer_geom_type_s*. Valid values are: "Point", "Line", "Polygon", and "Raster".
+
+h2. Derived metadata used by Solr index
+
+* *solr_bbox*: Bounding box as maximum values for W S E N. Example: "76.76 12.62309 84.76618 19.91705"
+* *solr_geom*: Shape of the layer as a Point, LineString, or Polygon WKT.
+Example: "POLYGON((76.76 19.91705, 84.76618 19.91705, 84.76618 12.62309, 76.76 12.62309, 76.76 19.91705))"
+* *solr_ne_pt* (from solr_bbox). North-eastern most point of the bounding box, as (y, x). Example: "83.1,-128.5"
+* *solr_sw_pt* (from solr_bbox). South-western most point of the bounding box, as (y, x). Example: "81.2,-130.1"
+* *solr_year_i* (from dc_coverage_temporal_sm): Year for which layer is valid. Example: 2012.
+
+h2. Solr schema syntax
+
+See complete schema on https://github.com/sul-dlss/geomdtk/blob/master/solr/kurma-app-test/conf/schema.xml
+
+Note on the types:
+
+|| Suffix || Solr data type using dynamicField ||
+| \_s | String |
+| \_sm | String, multivalued |
+| \_t | Text, English |
+| \_i | Integer |
+| \_dt | Date time |
+| \_url | URL as a non-indexed String |
+| \_bbox | Spatial bounding box, Rectangle as (w, s, e, n) |
+| \_pt | Spatial point as (y,x) |
+| \_geom | Spatial shape as WKT |
+
+
+{code:xml}
+<?xml version="1.0" encoding="UTF-8"?>
+<schema name="GeoBlacklight" version="1.5">
+  <uniqueKey>uuid</uniqueKey>
+  <fields>
+  ...
+    <!-- Spatial field types:
+    
+         Solr3:
+           <field name="my_pt">83.1,-117.312</field> 
+             as (y,x)
+
+         Solr4:             
+
+           <field name="my_bbox">-117.312 83.1 -115.39 84.31</field> 
+             as (W S E N)
+
+           <field name="my_geom">POLYGON((1 8, 1 9, 2 9, 2 8, 1 8))</field> 
+             as WKT for point, linestring, polygon
+
+      -->
+    <dynamicField name="*_pt"     type="location"     stored="true" indexed="true"/>
+    <dynamicField name="*_bbox"   type="location_rpt" stored="true" indexed="true"/>
+    <dynamicField name="*_geom"   type="location_jts" stored="true" indexed="true"/>
+  </fields>
+  <types>
+    ...
+    <fieldType name="location" class="solr.LatLonType" subFieldSuffix="_d"/>
+    <fieldType name="location_rpt" class="solr.SpatialRecursivePrefixTreeFieldType"
+               distErrPct="0.025"
+               maxDistErr="0.000009"
+               units="degrees"
+            />
+    <fieldType name="location_jts" class="solr.SpatialRecursivePrefixTreeFieldType"
+               spatialContextFactory="com.spatial4j.core.context.jts.JtsSpatialContextFactory"
+               distErrPct="0.025"
+               maxDistErr="0.000009"
+               units="degrees"
+            />
+  </types>
+</schema>
+{code}
+
+
+----
+h1. Solr queries
+
+* Use the Solr query interface with LatLon data on [sul-solr-a|http://sul-solr-a/solr/#/] to try these using ogp core.
+* For the polygon or JTS queries use [ogpapp-test|http://localhost:8983/solr/#/] via ssh tunnel to jetty 8983.
+
+h2. Solr 3: Pseudo-spatial using _solr.LatLon_
+
+{warning}
+solr.LatLonType does not correctly work across the international dateline in these queries. _latlon in these examples are assumed to be solr.LatLonType.
+{warning}
+
+h3. Search for point within 50 km of N40 W114
+
+Note: Solr _bbox_ uses circle with radius not rectangles.
+
+{code:xml}
+<str name="d">50</str>
+<str name="q">*:*</str>
+<str name="sfield">solr_latlon</str>
+<str name="pt">40,-114</str>
+<str name="fq">{!geofilt}</str>
+{code}
+
+
+h3. Search for single point _within_ a bounding box of SW=40,-120 NE=50,-110
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_latlon:[40,-120 TO 50,-110]</str>
+{code}
+
+h3. Search for bounding box _within_ a bounding box of SW=20,-160 NE=70,-70
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_sw_latlon:[20,-160 TO 70,-70] AND solr_ne_latlon:[20,-160 TO 70,-70]</str>
+{code}
+
+h2. Solr 4 Spatial -- non JTS
+
+{warning}
+_pt and _bbox in these examples are assumed to be solr.SpatialRecursivePrefixTreeFieldType.
+{warning}
+
+h3. Search for point _within_ a bounding box of SW=20,-160 NE=70,-70
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_pt:"Intersects(-160 20 -70 70)"</str>
+{code}
+
+h3. Search for bounding box _within_ a bounding box of SW=20,-160 NE=70,-70
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_sw_pt:[20,-160 TO 70,-70] AND solr_ne_pt:[20,-160 TO 70,-70]</str>
+{code}
+
+
+h3. Solr 4: ... using polygon intersection
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_bbox:"Intersects(-160 20 -70 70)"</str>
+{code}
+
+
+h3. Solr 4: ... using polygon containment
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_bbox:"IsWithin(-160 20 -150 30)"</str>
+{code}
+
+h3. Solr 4: ... using polygon containment for spatial relevancy
+
+{code:xml}
+<str name="q">solr_bbox:"IsWithin(-160 20 -150 30)"^10 railroads</str>
+<str name="fq">solr_bbox:"Intersects(-160 20 -150 30)"</str>
+{code}
+
+
+h2. Solr 4 Spatial -- JTS
+
+{warning}
+This query requires [JTS|http://tsusiatsoftware.net/jts/main.html] installed in Solr 4, where the spatialContextFactory="com.spatial4j.core.context.jts.JtsSpatialContextFactory" for the solr.SpatialRecursivePrefixTreeFieldType field class.
+{warning}
+
+
+h3. Search for bbox _intersecting_ bounding box of SW=20,-160 NE=70,-70 using polygon intersection
+
+
+{code:xml}
+<str name="q">*:*</str>
+<str name="fq">solr_bbox:"Intersects(POLYGON((-160 20, -160 70, -70 70, -70 20, -160 20)))"</str>
+{code}
+
+
+h2. Scoring formula
+
+{code}
+text^1
+dc_description_ti^2
+dc_creator_tmi^3
+dc_publisher_ti^3
+dct_isPartOf_tmi^4
+dc_subject_tmi^5
+dct_spatial_tmi^5
+dct_temporal_tmi^5
+dc_title_ti^6
+dc_rights_ti^7
+dct_provenance_ti^8
+layer_geom_type_ti^9
+layer_slug_ti^10
+dc_identifier_ti^10
+{code}
+
+h2. Facets
+
+{code:xml}
+<str name="facet.field">dct_spatial_sm</str>
+<str name="facet.field">dc_format_s</str>
+<str name="facet.field">dc_language_s</str>
+<str name="facet.field">dc_publisher_s</str>
+<str name="facet.field">dc_rights_s</str>
+<str name="facet.field">dct_provenance_s</str>
+<str name="facet.field">dc_subject_sm</str>
+<str name="facet.field">dct_isPartOf_sm</str>
+<str name="facet.field">layer_geom_type_s</str>
+<str name="facet.field">solr_year_i</str>
+{code}
+
+
+----
+h1. Solr example documents
+
+See [https://github.com/sul-dlss/geohydra/blob/master/ogp/transform.rb].
+
+These metadata would be generated from the OGP Schema, or MODS, or FGDC, or ISO 19139.
+
+{code}
+
+  "uuid": "http://purl.stanford.edu/zy658cr1728",
+  "dc_description_s": "This point dataset shows village locations with socio-demographic and economic Census data f
+or 2001 for the Union Territory of Andaman and Nicobar Islands, India linked to the 2001 Census. Includes village s
+ocio-demographic and economic Census attribute data such as total population, population by sex, household, literac
+y and illiteracy rates, and employment by industry. This layer is part of the VillageMap dataset which includes soc
+io-demographic and economic Census data for 2001 at the village level for all the states of India. This data layer 
+is sourced from secondary government sources, chiefly Survey of India, Census of India, Election Commission, etc. T
+his map Includes data for 547 villages, 3 towns, 2 districts, and 1 union territory.; This dataset is intended for 
+researchers, students, and policy makers for reference and mapping purposes, and may be used for village level demo
+graphic analysis within basic applications to support graphical overlays and analysis with other spatial data.; ",
+  "dc_format_s": "Shapefile",
+  "dc_identifier_s": "http://purl.stanford.edu/zy658cr1728",
+  "dc_language_s": "English",
+  "dc_publisher_s": "ML InfoMap (Firm)",
+  "dc_rights_s": "Restricted",
+  "dc_subject_sm": [
+    "Human settlements",
+    "Villages",
+    "Census",
+    "Demography",
+    "Population",
+    "Sex ratio",
+    "Housing",
+    "Labor supply",
+    "Caste",
+    "Literacy",
+    "Society",
+    "",
+    "Location"
+  ],
+  "dc_title_s": "Andaman and Nicobar, India: Village Socio-Demographic and Economic Census Data, 2001",
+  "dc_type_s": "Dataset",
+  "dct_isPartOf_sm": "My Collection",
+  "dct_references_sm": [
+    "scheme=\"urn:ogc:serviceType:WebFeatureService\" url=\"http://geowebservices-restricted.stanford.edu/geoserver/wfs\"",
+    "scheme=\"urn:ogc:serviceType:WebMapService\" url=\"http://geowebservices-restricted.stanford.edu/geoserver/wms\"",
+    "scheme=\"urn:iso:dataFormat:19139\" url=\"http://purl.stanford.edu/zy658cr1728.iso19139\"",
+    "scheme=\"urn:x-osgeo:link:www\" url=\"http://purl.stanford.edu/zy658cr1728\"",
+    "scheme=\"urn:loc:dataFormat:MODS\" url=\"http://purl.stanford.edu/zy658cr1728.mods\"",
+    "scheme=\"urn:x-osgeo:link:www-thumbnail\", url=\"http://example.com/preview.jpg\""
+  ],
+  "dct_spatial_sm": [
+    "Andaman and Nicobar Islands",
+    "Andaman",
+    "Nicobar",
+    "Car Nicobar Island",
+    "Port Blair",
+    "Indira Point",
+    "Diglipur",
+    "Nancowry Island"
+  ],
+  "dct_temporal_sm": "2001-01-01T00:00:00Z",
+  "dct_issued_dt": "2000-01-01T00:00:00Z",
+  "dct_provenance_s": "Stanford",
+  "georss_box_s": "6.761581 92.234924 13.637013 94.262535",
+  "georss_polygon_s": "13.637013 92.234924 13.637013 94.262535 6.761581 94.262535 6.761581 92.234924 13.637013 92.234924",
+  "layer_slug_s": "stanford-zy658cr1728",
+  "layer_id_s": "druid:zy658cr1728",
+  "layer_srs_s": "EPSG:4326",
+  "layer_geom_type_s": "Point",
+  "solr_bbox": "92.234924 6.761581 94.262535 13.637013",
+  "solr_ne_pt": "13.637013,94.262535",
+  "solr_sw_pt": "6.761581,92.234924",
+  "solr_geom": "POLYGON((92.234924 13.637013, 94.262535 13.637013, 94.262535 6.761581, 92.234924 6.761581, 92.234924 13.637013))"
+  "score": 1.6703978
+}
+{code}
+
+h1. Links
+
+* Solr 4: [http://wiki.apache.org/solr/SolrAdaptersForLuceneSpatial4]
+* Solr 3: [http://wiki.apache.org/solr/SpatialSearch]
+* JTS: [http://tsusiatsoftware.net/jts/main.html]