Geographic search and display

config/vufind/config.ini

@@ -739,11 +739,29 @@ authors         = Wikipedia
 ; recommendation module in searches.ini for more information)
 ;europeanaAPI = INSERTKEY
 
-; If this is set, a new map tab will show on the record page for records which
-; have long_lat data (see import/marc_local.properties for more information).
-; The setting specifies the type of map; currently, the only supported value is
-; "google"
-;recordMap = google
+; Geographic Display
+; recordMap can be set to either 'google' or 'openlayers';
+; 'google' will only display point features
+; 'openlayers' will display point and rectangle features. Default setting
+; (see import/marc_local.properties for more information).
+; Map Tab Options:
+; mapLabels:  leave empty, file:filename, or driver
+;      Leave it empty – no map labels will be displayed (default)
+;      file:filename - specify a file name after the colon for the
+;             coordinate/label lookup file. Coordinates in file must
+;             be specified as WENS.
+;      driver - Use the getCoordinateLabels method of the record driver to fetch labels;
+;               by default this relies on the long_lat_label field in Solr,
+;               but you can override the behavior with custom record driver code.
+;               The field must be the same length as the number of coordinate sets.
+;               Coordinates will be matched to labels on an ordered basis such that
+;               label[0] will be assigned for coordinate[0] and so forth.
+; displayCoords: true or false. Default is false. (Only for recordMap = openlayers)
+;                If displayCoords is true, then the coordinate values from
+;                coordinate field will be displayed before the map label in the label popup.
+recordMap = openlayers
+mapLabels = file:geosearch_test_lookup.txt
+displayCoords = true
 
 ; If you set recordMap = google, then Google requires that you obtain an API key.
 ; For more information on obtaining an API key, see:

config/vufind/searches.ini

@@ -51,6 +51,7 @@ case_sensitive_ranges = true
 ; [NoResultsRecommendations] sections below.
 ; See the comments above those sections for details on legal settings.  You may
 ; repeat these lines to load multiple recommendations.
+;default_top_recommend[] = MapSelection ; see [MapSelection] below for details
 default_top_recommend[] = TopFacets:ResultsTop
 default_top_recommend[] = SpellingSuggestions
 ;default_top_recommend[] = VisualFacets:Visual_Settings
@@ -120,6 +121,7 @@ Author              = Author
 Subject             = Subject
 CallNumber          = "Call Number"
 ISN                 = "ISBN/ISSN"
+;Coordinate        = Coordinates
 tag                 = Tag
 
 ; This section defines which search options will be included on the advanced
@@ -136,6 +138,8 @@ publisher           = adv_search_publisher
 Series              = adv_search_series
 year                = adv_search_year
 toc                 = adv_search_toc
+;Coordinate        = Coordinates
+
 
 ; This section defines the sort options available on standard search results.
 ; Values on the left of the equal sign are either the reserved term "relevance"
@@ -317,6 +321,13 @@ CallNumber = callnumber-sort
 ;       AuthorityRecommend:__resultlimit__:50 then authority recommendations will
 ;       only display on result screens displaying fewer than 50 hits; by default,
 ;       recommendations will always display). Filtering is optional.
+; MapSelection:[ini section]:[ini name]
+;       Enable geographic searching capability via OpenLayers3 API by activating
+;       this module. Records must be indexed using the geographic search and display
+;       fields. See the marc_local.properties file for more information on indexing.
+;       Default settings and more comments may be found in the  [MapSelection]
+;       section in this file. The section name and ini file name loaded by the
+;       module may be overridden through the [ini section]/[ini name] parameters.
 ; PubDateVisAjax:[zooming]:[facet field 1]:[facet field 2]:...:[facet field n]
 ;       Display a visualization of publication dates for each of the specified facet
 ;       fields.  This is designed for a field containing four-digit years.  Zooming
@@ -493,6 +504,7 @@ Author = "Solr:Author:author,author2"
 Subject = "Solr:Subject:topic,genre,geographic,era"
 CallNumber = "SolrCN"
 ISN = "Solr:ISN:isbn,issn"
+Coordinate = "None"
 tag = "Tag"
 
 ; When snippets are enabled, this section can be used to display captions based on
@@ -607,6 +619,26 @@ view=full
 ; from the actual record by period, e.g. testsrc.12345)
 ;sources = alli,testsrc
 
+; This section defines the default parameters for the geographic search
+; functionality found in the MapSelection recommendation module.
+; To enable this feature, uncomment the default_top_recommend[] = MapSelection
+; in the default recommendations section. To set the configuration settings 
+; for this feature, adjust the parameters below.
+[MapSelection]
+; This defines the coordinates of a search region that will be highlighted when
+; the user clicks the "Geographic Search" link next to the VuFind search box.
+; This should ideally cover a large area of the map where most/all of your
+; geographic points are located. If your dataset is not concentrated in one 
+; geographic area, it is advised that you pick a default area, and do not use
+; the entire extent of the map for searching (otherwise the search may be slow).
+; The default coordinates specified below are in decimal degrees, and are 
+; ordered as WENS (west, east, north, south). Ranges of valid values are:
+; -180 to 180 (longitude) and -85 to 85 (latitude). Note, to search from and to
+; the international date line, use west = -179 and east = -180. 
+default_coordinates = "-95, 30, 72, 15"
+; height: Height in pixels of the map selection interface.
+height = 320
+
 ; This section defines settings used to fetch similar records.
 [MoreLikeThis]
 ; Boolean value indicating whether the newer MoreLikeThis query handler should be

config/vufind/searchspecs.yaml

@@ -194,6 +194,12 @@ Subject:
 #    DismaxFields:
 #      - topic_unstemmed^150
 
+
+Coordinate:
+  DismaxFields:
+    - long_lat_display
+  DismaxHandler: edismax
+
 # This field definition is a compromise that supports both journal-level and
 # article-level data.  The disadvantage is that hits in article titles will
 # be mixed in.  If you are building a purely article-oriented index, you should
@@ -264,6 +270,7 @@ AllFields:
     - description
     - isbn
     - issn
+    - long_lat_display
   DismaxHandler: edismax
 #  ExactSettings:
 #    DismaxFields:

import/index_java/src/org/solrmarc/index/VuFindIndexer.java

@@ -35,6 +35,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Properties;
+import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
@@ -81,6 +82,10 @@ public class VuFindIndexer extends SolrIndexer
     private SimpleDateFormat marc005date = new SimpleDateFormat("yyyyMMddHHmmss.S");
     private SimpleDateFormat marc008date = new SimpleDateFormat("yyMMdd");
 
+    private static final Pattern COORDINATES_PATTERN = Pattern.compile("^([eEwWnNsS])(\\d{3})(\\d{2})(\\d{2})");
+    private static final Pattern HDMSHDD_PATTERN = Pattern.compile("^([eEwWnNsS])(\\d+(\\.\\d+)?)");
+    private static final Pattern PMDD_PATTERN = Pattern.compile("^([+-])(\\d+(\\.\\d+)?)");
+
     private static ConcurrentHashMap<String, Ini> configCache = new ConcurrentHashMap<String, Ini>();
 
     // Shutdown flag:
@@ -1380,6 +1385,225 @@ public List<String> getDeweySortables(Record record, String fieldSpec) {
     }
 
     /**
+     * The following several methods are designed to get latitude and longitude
+     * coordinates.
+     * Records can have multiple coordinates sets of points and/or rectangles.
+     * Points are represented by coordinate sets where N=S E=W.
+     *
+     * code adapted from xrosecky - Moravian Library
+     * https://github.com/moravianlibrary/VuFind-2.x/blob/master/import/index_scripts/geo.bsh
+     * and incorporates VuFind location.bsh functionality for GoogleMap display.
+     */
+
+    /**
+     * Convert MARC coordinates into bbox_geo format.
+     *
+     * @param  Record record
+     * @return List   geo_coordinates
+     */
+    public List<String> getAllCoordinates(Record record) {
+        List<String> geo_coordinates = new ArrayList<String>();
+        List<VariableField> list034 = record.getVariableFields("034");
+        if (list034 != null) {
+            for (VariableField vf : list034) {
+                DataField df = (DataField) vf;
+                String d = df.getSubfield('d').getData();
+                String e = df.getSubfield('e').getData();
+                String f = df.getSubfield('f').getData();
+                String g = df.getSubfield('g').getData();
+                //System.out.println("raw Coords: "+d+" "+e+" "+f+" "+g);
+
+                // Check to see if there are only 2 coordinates
+                // If so, copy them into the corresponding coordinate fields
+                if ((d !=null && (e == null || e.trim().equals(""))) && (f != null && (g==null || g.trim().equals("")))) {
+                    e = d;
+                    g = f;
+                }
+                if ((e !=null && (d == null || d.trim().equals(""))) && (g != null && (f==null || f.trim().equals("")))) {
+                    d = e;
+                    f = g;
+                }
+
+                // Check and convert coordinates to +/- decimal degrees
+                Double west = convertCoordinate(d);
+                Double east = convertCoordinate(e);
+                Double north = convertCoordinate(f);
+                Double south = convertCoordinate(g);
+
+                // New Format for indexing coordinates in Solr 5.0 - minX, maxX, maxY, minY
+                // Note - storage in Solr follows the WENS order, but display is WSEN order
+                String result = String.format("ENVELOPE(%s,%s,%s,%s)", new Object[] { west, east, north, south });
+
+                if (validateCoordinates(west, east, north, south)) {
+                    geo_coordinates.add(result);
+                }
+            }
+        }
+        return geo_coordinates;
+    }
+
+    /**
+     * Get point coordinates for GoogleMap display.
+     *
+     * @param  Record record
+     * @return List   coordinates
+     */
+    public List<String> getPointCoordinates(Record record) {
+        List<String> coordinates = new ArrayList<String>();
+        List<VariableField> list034 = record.getVariableFields("034");
+        if (list034 != null) {
+            for (VariableField vf : list034) {
+                DataField df = (DataField) vf;
+                String d = df.getSubfield('d').getData();
+                String e = df.getSubfield('e').getData();
+                String f = df.getSubfield('f').getData();
+                String g = df.getSubfield('g').getData();
+
+                // Check to see if there are only 2 coordinates
+                if ((d !=null && (e == null || e.trim().equals(""))) && (f != null && (g==null || g.trim().equals("")))) {
+                    Double long_val = convertCoordinate(d);
+                    Double lat_val = convertCoordinate(f);
+                    String longlatCoordinate = Double.toString(long_val) + ',' + Double.toString(lat_val);
+                    coordinates.add(longlatCoordinate);
+                }
+                if ((e !=null && (d == null || d.trim().equals(""))) && (g != null && (f==null || f.trim().equals("")))) {
+                    Double long_val = convertCoordinate(e);
+                    Double lat_val = convertCoordinate(g);
+                    String longlatCoordinate = Double.toString(long_val) + ',' + Double.toString(lat_val);
+                    coordinates.add(longlatCoordinate);
+                }
+                // Check if N=S and E=W
+                if (d.equals(e) && f.equals(g)) {
+                    Double long_val = convertCoordinate(d);
+                    Double lat_val = convertCoordinate(f);
+                    String longlatCoordinate = Double.toString(long_val) + ',' + Double.toString(lat_val);
+                    coordinates.add(longlatCoordinate);
+                }
+            }
+        }
+        return coordinates;
+    }
+
+    /**
+     * Get all available coordinates from the record.
+     *
+     * @param  Record record
+     * @return List   geo_coordinates
+     */
+    public List<String> getDisplayCoordinates(Record record) {
+        List<String> geo_coordinates = new ArrayList<String>();
+        List<VariableField> list034 = record.getVariableFields("034");
+        if (list034 != null) {
+            for (VariableField vf : list034) {
+                DataField df = (DataField) vf;
+                String west = df.getSubfield('d').getData();
+                String east = df.getSubfield('e').getData();
+                String north = df.getSubfield('f').getData();
+                String south = df.getSubfield('g').getData();
+                String result = String.format("%s %s %s %s", new Object[] { west, east, north, south });
+                if (west != null || east != null || north != null || south != null) {
+                    geo_coordinates.add(result);
+                }
+            }
+        }
+        return geo_coordinates;
+    }
+
+    /**
+     * Check coordinate type HDMS HDD or +/-DD.
+     *
+     * @param  String coordinateStr
+     * @return Double coordinate
+     */
+    protected Double convertCoordinate(String coordinateStr) {
+        Double coordinate = Double.NaN;
+        Matcher HDmatcher = HDMSHDD_PATTERN.matcher(coordinateStr);
+        Matcher PMDmatcher = PMDD_PATTERN.matcher(coordinateStr);
+        if (HDmatcher.matches()) {
+            String hemisphere = HDmatcher.group(1).toUpperCase();
+            Double degrees = Double.parseDouble(HDmatcher.group(2));
+            // Check for HDD or HDMS
+            if (hemisphere.equals("N") || hemisphere.equals("S")) {
+                if (degrees > 90) {
+                    String hdmsCoordinate = hemisphere+"0"+HDmatcher.group(2);
+                    coordinate = coordinateToDecimal(hdmsCoordinate);
+                } else {
+                    coordinate = Double.parseDouble(HDmatcher.group(2));
+                    if (hemisphere.equals("S")) {
+                        coordinate *= -1;
+                    }
+                }
+            }
+            if (hemisphere.equals("E") || hemisphere.equals("W")) {
+                if (degrees > 180) {
+                    String hdmsCoordinate = HDmatcher.group(0);
+                    coordinate = coordinateToDecimal(hdmsCoordinate);
+                } else {
+                    coordinate = Double.parseDouble(HDmatcher.group(2));
+                    if (hemisphere.equals("W")) {
+                        coordinate *= -1;
+                    }
+                }
+            }
+            return coordinate;
+        } else if (PMDmatcher.matches()) {
+            String hemisphere = PMDmatcher.group(1);
+            coordinate = Double.parseDouble(PMDmatcher.group(2));
+            if (hemisphere.equals("-")) {
+                coordinate *= -1;
+            }
+            return coordinate;
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Convert HDMS coordinates to decimal degrees.
+     *
+     * @param  String coordinateStr
+     * @return Double coordinate
+     */
+    protected Double coordinateToDecimal(String coordinateStr) {
+        Matcher matcher = COORDINATES_PATTERN.matcher(coordinateStr);
+        if (matcher.matches()) {
+            String hemisphere = matcher.group(1).toUpperCase();
+            int degrees = Integer.parseInt(matcher.group(2));
+            int minutes = Integer.parseInt(matcher.group(3));
+            int seconds = Integer.parseInt(matcher.group(4));
+            double coordinate = degrees + (minutes / 60.0) + (seconds / 3600.0);
+            if (hemisphere.equals("W") || hemisphere.equals("S")) {
+                coordinate *= -1;
+            }
+            return coordinate;
+        }
+        return null;
+    }
+
+    /**
+     * Check decimal degree coordinates to make sure they are valid.
+     *
+     * @param  Double west, east, north, south
+     * @return boolean
+     */
+    protected boolean validateCoordinates(Double west, Double east, Double north, Double south) {
+        if (west == null || east == null || north == null || south == null) {
+            return false;
+        }
+        if (west > 180.0 || west < -180.0 || east > 180.0 || east < -180.0) {
+            return false;
+        }
+        if (north > 90.0 || north < -90.0 || south > 90.0 || south < -90.0) {
+            return false;
+        }
+        if (north < south || west > east) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * THIS FUNCTION HAS BEEN DEPRECATED.
      * Determine the longitude and latitude of the items location.
      *
      * @param  record current MARC record
@@ -1416,7 +1640,7 @@ public String getLongLat(Record record) {
                         val = val + ',' + val2;
                     }
                 }
-            return val;
+                return val;
             }
         }
         //otherwise return null