Project

General

Profile

1 3035 perry
/**
2
 *  '$RCSfile$'
3
 *  Copyright: 2003 Regents of the University of California.
4
 *
5
 * Author: Matthew Perry
6
 * '$Date$'
7
 * '$Revision$'
8
 *
9
 * This program is free software; you can redistribute it and/or modify
10
 * it under the terms of the GNU General Public License as published by
11
 * the Free Software Foundation; either version 2 of the License, or
12
 * (at your option) any later version.
13
 *
14
 * This program is distributed in the hope that it will be useful,
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 * GNU General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU General Public License
20
 * along with this program; if not, write to the Free Software
21
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22
 */
23
package edu.ucsb.nceas.metacat.spatial;
24
25 5015 daigle
import edu.ucsb.nceas.metacat.database.DBConnection;
26 5030 daigle
import edu.ucsb.nceas.metacat.properties.PropertyService;
27 4699 daigle
import edu.ucsb.nceas.metacat.util.MetacatUtil;
28 4080 daigle
import edu.ucsb.nceas.metacat.util.SystemUtil;
29
import edu.ucsb.nceas.utilities.PropertyNotFoundException;
30 3035 perry
31
import com.vividsolutions.jts.geom.Coordinate;
32
import com.vividsolutions.jts.geom.Point;
33
import com.vividsolutions.jts.geom.Polygon;
34
import com.vividsolutions.jts.geom.MultiPolygon;
35
import com.vividsolutions.jts.geom.MultiPoint;
36
import com.vividsolutions.jts.geom.GeometryFactory;
37
import com.vividsolutions.jts.geom.PrecisionModel;
38
39 5829 leinfelder
import org.geotools.feature.simple.SimpleFeatureBuilder;
40
import org.opengis.feature.simple.SimpleFeature;
41
import org.opengis.feature.simple.SimpleFeatureType;
42 3035 perry
43
import java.sql.ResultSet;
44
import java.sql.PreparedStatement;
45
import java.util.Vector;
46
47
import org.apache.log4j.Logger;
48
49 3040 perry
/**
50 4080 daigle
 *
51
 * Class representing the spatial portions of an xml document as a geotools
52
 * Feature.
53 3040 perry
 */
54 3035 perry
public class SpatialDocument {
55
56 4080 daigle
	private DBConnection dbconn;
57 3035 perry
58 4080 daigle
	private static Logger log = Logger.getLogger(SpatialDocument.class.getName());
59 3035 perry
60 4080 daigle
	private SpatialFeatureSchema featureSchema = new SpatialFeatureSchema();
61 3035 perry
62 4080 daigle
	Vector west = new Vector();
63
	Vector south = new Vector();
64
	Vector east = new Vector();
65
	Vector north = new Vector();
66 3035 perry
67 4080 daigle
	String title = "";
68
	String docid = null;
69 3035 perry
70 4080 daigle
	/**
71
	 * Constructor that queries the db
72
	 *
73
	 * @param docid
74
	 *            The document id to be represented spatially
75
	 * @param dbconn
76
	 *            The database connection shared from the refering method.
77
	 */
78
	public SpatialDocument(String docid, DBConnection dbconn) {
79 3035 perry
80 4080 daigle
		this.docid = docid;
81
		PreparedStatement pstmt = null;
82
		ResultSet rs = null;
83
		this.dbconn = dbconn;
84
		boolean isSpatialDocument = false;
85
		String thisDocname = null;
86
		String westPath = null;
87
		String eastPath = null;
88
		String northPath = null;
89
		String southPath = null;
90 3035 perry
91 4080 daigle
		/*
92
		 * Determine the docname/schema and decide how to proceed with spatial
93
		 * harvest
94
		 */
95
		String query = "SELECT docname FROM xml_documents WHERE docid='" + docid.trim()
96
				+ "';";
97
		String docname = "";
98
		try {
99
			pstmt = dbconn.prepareStatement(query);
100
			pstmt.execute();
101
			rs = pstmt.getResultSet();
102
			while (rs.next()) {
103
				docname = rs.getString(1);
104
			}
105
			rs.close();
106
			pstmt.close();
107
		} catch (Exception e) {
108
			log.error(" ---- Could not get docname for " + docid);
109
			e.printStackTrace();
110
		}
111
		if (docname == null)
112
			docname = "";
113 3035 perry
114 4080 daigle
		// Loop through all our spatial docnames and determine if the current
115
		// document matches
116
		// If so, get the appropriate corner xpaths
117
		try {
118 4699 daigle
			Vector spatialDocnames = MetacatUtil.getOptionList(PropertyService
119 4178 daigle
					.getProperty("spatial.spatialDocnameList"));
120 4080 daigle
			for (int i = 0; i < spatialDocnames.size(); i++) {
121
				thisDocname = ((String) spatialDocnames.elementAt(i)).trim();
122
				if (docname.trim().equals(thisDocname)) {
123
					isSpatialDocument = true;
124 3035 perry
125 4080 daigle
					// determine its east,west,north and south coord xpaths
126 4178 daigle
					westPath = PropertyService.getProperty("spatial." + thisDocname
127 4080 daigle
							+ "_westBoundingCoordinatePath");
128 4178 daigle
					eastPath = PropertyService.getProperty("spatial." + thisDocname
129 4080 daigle
							+ "_eastBoundingCoordinatePath");
130 4178 daigle
					northPath = PropertyService.getProperty("spatial." + thisDocname
131 4080 daigle
							+ "_northBoundingCoordinatePath");
132 4178 daigle
					southPath = PropertyService.getProperty("spatial." + thisDocname
133 4080 daigle
							+ "_southBoundingCoordinatePath");
134
				}
135
			}
136
		} catch (PropertyNotFoundException pnfe) {
137
			log.error("Could not find spatialDocnameList or bounding coordinate "
138
					+ "path for: " + docid);
139
			pnfe.printStackTrace();
140
		}
141 3120 perry
142 4080 daigle
		// If it is a spatial document, harvest the corners and title
143
		if (isSpatialDocument) {
144 3120 perry
145 4080 daigle
			/*
146
			 * Get the bounding coordinates
147
			 */
148
			query = "SELECT path, nodedatanumerical, parentnodeid FROM xml_path_index"
149
					+ " WHERE docid = '"
150
					+ docid.trim()
151
					+ "'"
152
					+ " AND docid IN (SELECT distinct docid FROM xml_access WHERE docid = '"
153
					+ docid.trim()
154
					+ "' AND principal_name = 'public' AND perm_type = 'allow')"
155
					+ " AND (path = '" + westPath + "'" + "  OR path = '" + southPath
156
					+ "'" + "  OR path = '" + eastPath + "'" + "  OR path = '"
157
					+ northPath + "'" + " ) ORDER BY parentnodeid;";
158 3120 perry
159 4080 daigle
			try {
160
				pstmt = dbconn.prepareStatement(query);
161
				pstmt.execute();
162
				rs = pstmt.getResultSet();
163
				while (rs.next()) {
164
					if (rs.getString(1).equals(westPath))
165
						this.west.add(new Float(rs.getFloat(2)));
166
					else if (rs.getString(1).equals(southPath))
167
						this.south.add(new Float(rs.getFloat(2)));
168
					else if (rs.getString(1).equals(eastPath))
169
						this.east.add(new Float(rs.getFloat(2)));
170
					else if (rs.getString(1).equals(northPath))
171
						this.north.add(new Float(rs.getFloat(2)));
172
					else
173
						log.error("** An xml path not related to your bounding coordinates was returned by this query \n"
174
										+ query + "\n");
175
				}
176
				rs.close();
177
				pstmt.close();
178
			} catch (Exception e) {
179
				log.error(" ---- Could not get bounding coordinates for " + docid);
180
				e.printStackTrace();
181
			}
182 3120 perry
183 4080 daigle
			/*
184
			 * Get the title
185
			 */
186 3035 perry
187 4080 daigle
			try {
188
189 4178 daigle
				String docTitlePath = PropertyService.getProperty("spatial.docTitle");
190 4080 daigle
				query = "select nodedata from xml_path_index where path = '"
191
						+ docTitlePath.trim() + "' and docid = '" + docid.trim() + "'";
192
				pstmt = dbconn.prepareStatement(query);
193
				pstmt.execute();
194
				rs = pstmt.getResultSet();
195
				if (rs.next())
196
					this.title = rs.getString(1);
197
				rs.close();
198
				pstmt.close();
199
			} catch (Exception e) {
200
				log.error(" **** Error getting docids from getTitle for docid = "
201
								+ docid);
202
				e.printStackTrace();
203
				this.title = docid;
204
			}
205
		}
206
207 3035 perry
  }
208
209 4080 daigle
  /**
210
	 * Returns a geotools (multi)polygon feature with geometry plus attributes
211
	 * ready to be inserted into our spatial dataset cache
212
	 */
213 5829 leinfelder
  public SimpleFeature getPolygonFeature() {
214 3035 perry
      // Get polygon feature type
215 5829 leinfelder
      SimpleFeatureType polyType = featureSchema.getPolygonFeatureType();
216 3035 perry
217
      MultiPolygon theGeom = getPolygonGeometry();
218
      if (theGeom == null)
219
          return null;
220
221
      // Populate the feature schema
222
      try {
223 5829 leinfelder
    	  SimpleFeatureBuilder builder = new SimpleFeatureBuilder(polyType);
224
    	  builder.addAll(
225
    			  new Object[]{
226
	                  theGeom,
227
	                  this.docid,
228
	                  getUrl(this.docid),
229
	                  this.title }
230
    			  );
231
          SimpleFeature polyFeature = builder.buildFeature(this.docid);
232 3035 perry
          return polyFeature;
233 5829 leinfelder
      } catch (Exception e) {
234
          log.error("Problem getting polygon feature: " + e.getMessage());
235 3035 perry
          return null;
236
      }
237
  }
238
239 3040 perry
  /**
240
   * Returns a geotools (multi)point feature with geometry plus attributes
241 3035 perry
   * ready to be inserted into our spatial dataset cache
242 3040 perry
   *
243 3035 perry
   */
244 5829 leinfelder
  public SimpleFeature getPointFeature() {
245 3035 perry
      // Get polygon feature type
246 5829 leinfelder
      SimpleFeatureType pointType = featureSchema.getPointFeatureType();
247 3035 perry
248
      MultiPoint theGeom = getPointGeometry();
249
      if (theGeom == null)
250
          return null;
251
252
      // Populate the feature schema
253
      try {
254 5829 leinfelder
    	  SimpleFeatureBuilder builder = new SimpleFeatureBuilder(pointType);
255
    	  builder.addAll(
256
    			  new Object[]{
257
	                  theGeom,
258
	                  this.docid,
259
	                  getUrl(this.docid),
260
	                  this.title }
261
    			  );
262
          SimpleFeature pointFeature = builder.buildFeature(this.docid);
263 3035 perry
          return pointFeature;
264 5829 leinfelder
      } catch (Exception e) {
265
          log.error("Problem getting point feature: " + e.getMessage());
266 3035 perry
          return null;
267
      }
268
  }
269
270 3040 perry
  /**
271 3035 perry
   * Given a valid docid, return an appropriate URL
272
   * for viewing the metadata document
273 3040 perry
   *
274
   * @param docid The document id for which to construct the access url.
275 3035 perry
   */
276
  private String getUrl( String docid ) {
277 4080 daigle
     String docUrl = null;
278
     try {
279
    	 docUrl = SystemUtil.getServletURL()
280
                    + "?action=read&docid=" + docid
281
                    + "&qformat="
282 4091 daigle
                    + PropertyService.getProperty("application.default-style");
283 4080 daigle
     } catch (PropertyNotFoundException pnfe) {
284
    	 log.error("Could not get access url because of unavailable property: "
285
    			 + pnfe.getMessage());
286
     }
287 3035 perry
288
     return docUrl;
289
  }
290
291 3040 perry
292 3035 perry
  /**
293 3037 perry
   * Returns a mutlipolygon geometry representing the geographic coverage(s) of the document
294 3040 perry
   *
295 3035 perry
   */
296
  private MultiPolygon getPolygonGeometry() {
297
298
    PrecisionModel precModel = new PrecisionModel(); // default: Floating point
299
    GeometryFactory geomFac = new GeometryFactory( precModel, featureSchema.srid );
300
    Vector polygons = new Vector();
301 3070 perry
    float w;
302
    float s;
303
    float e;
304
    float n;
305 3035 perry
306
    if ( west.size() == south.size() && south.size() == east.size() && east.size() == north.size() ) {
307
        for (int i = 0; i < west.size(); i++) {
308
309 3070 perry
            w = ((Float)west.elementAt(i)).floatValue();
310
            s = ((Float)south.elementAt(i)).floatValue();
311
            e = ((Float)east.elementAt(i)).floatValue();
312
            n = ((Float)north.elementAt(i)).floatValue();
313 3035 perry
314
            // Check if it's actually a valid polygon
315 3037 perry
            if (  w == 0.0 && s == 0.0 && e == 0.0 && n == 0.0) {
316 3035 perry
                log.warn("        Invalid or empty coodinates ... skipping");
317
                continue;
318 3070 perry
            } else if( Float.compare(w, e) == 0 && Float.compare(n,s) == 0 ) {
319 3035 perry
                log.warn("        Point coordinates only.. skipping polygon generation");
320
                continue;
321
            }
322
323 3037 perry
            // Handle the case of crossing the dateline and poles
324 3054 perry
            // dateline crossing is valid
325
            // polar crossing is not ( so we swap north and south )
326 3037 perry
            // Assumes all coordinates are confined to -180 -90 180 90
327 3070 perry
            float dl = 180.0f;
328
            float _dl = -180.0f;
329 3037 perry
330
            if ( w > e && s > n ) {
331 3054 perry
                log.info( "Crosses both the dateline and the poles .. split into 2 polygons, swap n & s" );
332
                polygons.add( createPolygonFromBbox( geomFac,   w,   n, dl, s ) );
333
                polygons.add( createPolygonFromBbox( geomFac, _dl,   n,  e, s ) );
334 3037 perry
            } else if ( w > e ) {
335
                log.info( "Crosses the dateline .. split into 2 polygons" );
336
                polygons.add( createPolygonFromBbox( geomFac,   w, s, dl, n ) );
337
                polygons.add( createPolygonFromBbox( geomFac, _dl, s,  e, n ) );
338
            } else if ( s > n ) {
339 3054 perry
                log.info( "Crosses the poles .. swap north and south" );
340
                polygons.add( createPolygonFromBbox( geomFac, w, n, e, s ) );
341 3037 perry
            } else {
342
                // Just a standard polygon that fits nicely onto our flat earth
343
                polygons.add( createPolygonFromBbox( geomFac, w, s, e, n ) );
344
            }
345
346
347 3035 perry
        }
348
    } else {
349
       log.error(" *** Something went wrong.. your east,west,north and south bounding arrays are different sizes!");
350
    }
351
352
    if( polygons.size() > 0 ) {
353
       Polygon[] polyArray = geomFac.toPolygonArray( polygons );
354
       MultiPolygon multiPolyGeom= geomFac.createMultiPolygon( polyArray );
355
       return multiPolyGeom;
356
    } else {
357
       return null;
358
    }
359
360
  }
361
362 3037 perry
363 3040 perry
  /**
364
   * Returns a polygon given the four bounding box coordinates
365 3037 perry
   */
366 3070 perry
  private Polygon createPolygonFromBbox( GeometryFactory geomFac, float w, float s, float e, float n ) {
367 3037 perry
368
        Coordinate[] linestringCoordinates = new Coordinate[5];
369
370
        linestringCoordinates[0] = new Coordinate( w, s );
371
        linestringCoordinates[1] = new Coordinate( w, n );
372
        linestringCoordinates[2] = new Coordinate( e, n );
373
        linestringCoordinates[3] = new Coordinate( e, s );
374
        linestringCoordinates[4] = new Coordinate( w, s );
375
376
        return geomFac.createPolygon( geomFac.createLinearRing(linestringCoordinates), null);
377
  }
378
379
380 3040 perry
  /**
381
   * Returns a multipoint geometry represnting the geographic coverage(s) of the document
382
   *
383
   * @todo Handle the case of crossing the dateline and poles
384 3035 perry
   */
385
  private MultiPoint getPointGeometry() {
386
387
    PrecisionModel precModel = new PrecisionModel(); // default: Floating point
388
    GeometryFactory geomFac = new GeometryFactory( precModel, featureSchema.srid );
389 3070 perry
    float w;
390
    float s;
391
    float e;
392
    float n;
393 3035 perry
394
    PreparedStatement pstmt = null;
395
    ResultSet rs = null;
396
397
    Vector points = new Vector();
398
399
    if ( west.size() == south.size() && south.size() == east.size() && east.size() == north.size() ) {
400
        for (int i = 0; i < west.size(); i++) {
401
402 3070 perry
            w = ((Float)west.elementAt(i)).floatValue();
403
            s = ((Float)south.elementAt(i)).floatValue();
404
            e = ((Float)east.elementAt(i)).floatValue();
405
            n = ((Float)north.elementAt(i)).floatValue();
406 3050 perry
407 3035 perry
            // Check if it's actually a valid point
408 3070 perry
            if (  w == 0.0f && s == 0.0f && e == 0.0f && n == 0.0f) {
409 3050 perry
                 log.warn("        Invalid or empty coodinates ... skipping");
410
                 continue;
411
            }
412 3035 perry
413 3070 perry
            float xCenter;
414
            float yCenter;
415 3050 perry
416
            // Handle the case of crossing the dateline and poles
417
            // Assumes all coordinates are confined to -180 -90 180 90
418
419 3054 perry
            if ( w > e ) {
420 3050 perry
                log.info( "Crosses the dateline .. " );
421 3070 perry
                xCenter = (360.0f - w + e)/ 2.0f + w;
422
                if( xCenter > 180.0f )
423
                    xCenter = xCenter - 360.0f;
424
                yCenter = ( s + n ) / 2.0f;
425 3050 perry
            } else {
426
                // Just a standard point that can be calculated by the average coordinates
427 3070 perry
                xCenter = ( w + e ) / 2.0f;
428
                yCenter = ( s + n ) / 2.0f;
429 3035 perry
            }
430
431
            points.add( geomFac.createPoint( new Coordinate( xCenter, yCenter)) );
432
        }
433
    } else {
434
       log.error(" *** Something went wrong.. your east,west,north and south bounding vectors are different sizes!");
435
    }
436
437
    if( points.size() > 0 ) {
438
       Point[] pointArray = geomFac.toPointArray( points );
439
       MultiPoint multiPointGeom= geomFac.createMultiPoint( pointArray );
440
       return multiPointGeom;
441
    } else {
442
       return null;
443
    }
444
445
446
  }
447
}