Project

General

Profile

1 3035 perry
/**
2
 *  '$RCSfile$'
3
 *  Copyright: 2000 Regents of the University of California and the
4
 *             National Center for Ecological Analysis and Synthesis
5
 *
6
 * Author: Matthew Perry
7
 * '$Date$'
8
 * '$Revision$'
9
 *
10
 * This program is free software; you can redistribute it and/or modify
11
 * it under the terms of the GNU General Public License as published by
12
 * the Free Software Foundation; either version 2 of the License, or
13
 * (at your option) any later version.
14
 *
15
 * This program is distributed in the hope that it will be useful,
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 * GNU General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU General Public License
21
 * along with this program; if not, write to the Free Software
22
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23
 */
24
25
package edu.ucsb.nceas.metacat.spatial;
26
27 5915 jones
import java.io.IOException;
28
import java.sql.PreparedStatement;
29 3035 perry
import java.sql.ResultSet;
30 5915 jones
import java.sql.SQLException;
31 3035 perry
import java.util.Vector;
32
33
import org.apache.log4j.Logger;
34 5915 jones
import org.opengis.feature.simple.SimpleFeature;
35 3035 perry
36 5015 daigle
import edu.ucsb.nceas.metacat.database.DBConnection;
37 4080 daigle
38 3040 perry
/**
39
 * Harvests spatial data from metacat database
40
 * and saves to persistent cache
41 3035 perry
 */
42
public class SpatialHarvester {
43
44
  private static Logger log = Logger.getLogger(SpatialHarvester.class.getName());
45
46
  private DBConnection dbconn;
47
48 3040 perry
  /**
49
   * constructor to initialize db connection
50
   */
51 3035 perry
  public SpatialHarvester() {
52
      try {
53
          dbconn = new DBConnection();
54
      } catch( Exception e ) {
55
          log.error("Error getting docids from queryAllDocids");
56
          e.printStackTrace();
57
      }
58
  }
59
60 3040 perry
  /**
61
   * Closes the database connection.
62
   * Should be called after you're done with the SpatialHarvester
63 3035 perry
   */
64
  public void destroy() {
65
      try {
66
          dbconn.close();
67 5915 jones
      } catch( SQLException e ) {
68 3040 perry
          log.error("Error closing out dbconn in spatial harvester");
69 3035 perry
          e.printStackTrace();
70
      }
71
  }
72
73
  /**
74
   * Returns a Vector of all the docids in the xml_path_index tables
75
   */
76 5915 jones
  protected Vector<String> queryAllDocids() {
77
    Vector<String> _docs = new Vector<String>();
78 3035 perry
    PreparedStatement pstmt = null;
79
    ResultSet rs = null;
80
81 3043 perry
    /*
82
     * For now, only allow publically readable docids
83
     * to be considered for the spatial cache
84
     */
85
    //String query = "select distinct docid from xml_path_index";
86
    String query = "select distinct docid from xml_access where principal_name = 'public' and perm_type = 'allow'";
87 3035 perry
88
    try {
89
      pstmt = dbconn.prepareStatement(query);
90
      pstmt.execute();
91
      rs = pstmt.getResultSet();
92
      while (rs.next()) {
93
        String docid = rs.getString(1);
94
        //log.fatal("adding docid: " + docid);
95
        _docs.add(docid);
96
    }
97
      rs.close();
98
      pstmt.close();
99
    }
100
    catch(Exception e) {
101
      log.error("Error getting docids from queryAllDocids");
102
      e.printStackTrace();
103
    }
104
    return _docs;
105
  }
106
107 3040 perry
  /**
108
   * Currently just a wrapper around the harvestDocument method.
109 3035 perry
   * Eventually we can use this method as a
110 3040 perry
   * timed que like the indexing process.
111
   *
112
   * @param docid The docid to be added to the spatial cache.
113 3035 perry
   */
114
  public void addToUpdateQue( String docid ) {
115
      harvestDocument(docid);
116
  }
117
118 3040 perry
  /**
119
   * Delete a given document from spatial cache.
120
   * Just a wrapper around deleteDocument method for now.
121
   *
122
   * @param docid The docid to be deleted from the spatial cache.
123 3035 perry
   */
124
  public void addToDeleteQue( String docid ) {
125
      deleteDocument(docid);
126
  }
127
128 3040 perry
  /**
129
   * Given a docid, will attempt to delete it from spatial cache
130
   *
131
   * @param docid The docid to be deleted from the spatial cache.
132 3035 perry
   */
133
  public void deleteDocument( String docid ) {
134
135 3201 tao
136 3035 perry
137
     try {
138 3201 tao
//    	 Read the existing spatial dataset cache
139
         SpatialDataset sds = new SpatialDataset();
140 3035 perry
         // Delete both the polygon(s) and point(s)
141
         sds.delete( "polygon" , docid );
142
         sds.delete( "point" , docid );
143
     } catch (IOException e) {
144
         log.error("IOException while deleting from spatial cache");
145
     }
146
147
     log.info(" --------- Spatial Harvester - Deleted from spatial cache : " + docid );
148
  }
149
150
151 3040 perry
  /**
152
   * Given a new or updated docid,
153
   * will update the spatial cache accordingly.
154
   *
155
   * @param docid The docid to be updated or inserted into the spatial cache.
156 3035 perry
   */
157
  public void harvestDocument( String docid ) {
158
159 3039 perry
     long before = System.currentTimeMillis();
160 3201 tao
161
     try {
162
         //Read the existing spatial dataset cache
163
         SpatialDataset sds = new SpatialDataset();
164 3035 perry
165 3201 tao
         // insert OR update the spatial cache
166
         // SpatialDataset.insertOrUpdate takes care of the difference
167
         SpatialDocument sdoc = new SpatialDocument( docid, dbconn );
168 3035 perry
169 5829 leinfelder
         SimpleFeature polygonFeature = sdoc.getPolygonFeature();
170 3035 perry
         sds.insertOrUpdate("polygon", polygonFeature, docid );
171
172 5829 leinfelder
         SimpleFeature pointFeature = sdoc.getPointFeature();
173 3035 perry
         sds.insertOrUpdate("point", pointFeature, docid );
174 3039 perry
         long after = System.currentTimeMillis();
175
         log.info(" ------- Spatial Harvester - spatial cache updated for : " + docid + ".... Time  " + (after - before) + "ms");
176 3035 perry
     } catch (IOException e) {
177
         log.error("IOException while performing spatial harvest ");
178
     }
179
  }
180
181 3040 perry
  /**
182
   * Completely regenerates the spatial cache.
183
   * This can take a long time, especially with lots of documents.
184 3035 perry
   */
185 3201 tao
  public void regenerate() throws IOException{
186 3035 perry
187
      // Create new Spatial Dataset
188
      SpatialDataset sds = new SpatialDataset();
189
190
      // Get list of all docids in the database
191 5915 jones
      Vector<String> docids = queryAllDocids();
192 3035 perry
193
      for (int i = 0; i < docids.size(); i++) {
194
          SpatialDocument sdoc = new SpatialDocument( (String)docids.elementAt(i), dbconn );
195
196
          // Get the polygon representation of SpatialDocument
197
          // and add it to the spatial dataset
198 5829 leinfelder
         SimpleFeature polygonFeature = sdoc.getPolygonFeature();
199 3035 perry
          sds.add("polygon", polygonFeature );
200
201
          // Get the point representation of SpatialDocument
202
          // and add it to the spatial dataset
203 5829 leinfelder
          SimpleFeature pointFeature = sdoc.getPointFeature();
204 3035 perry
          sds.add("point", pointFeature );
205
206
          log.info(" ****** Spatial harvest of docid " + docids.elementAt(i) );
207
      }
208
209
      // save SpatialDataset
210
      sds.save();
211
212
  }
213
214
}