Changeset 7518 in josm for trunk/src/org/openstreetmap/josm/data/gpx

Timestamp:

2014-09-10T02:29:55+02:00 (10 years ago)

Author:

Don-vip

Message:

fix #10489 - Add additional attributes to GPX Export for nodes + GPX code improvements

Location:

trunk/src/org/openstreetmap/josm/data/gpx

Files:

• GpxConstants.java (modified) (3 diffs)
• GpxData.java (modified) (1 diff)
• GpxLink.java (modified) (1 diff)
• IWithAttributes.java (modified) (1 diff)
• WayPoint.java (modified) (3 diffs)
• WithAttributes.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/data/gpx/GpxConstants.java

@@ -3 +3 @@
 
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 
@@ -11 +12 @@
  */
 public interface GpxConstants {
+
+    /** GPS name of the element. This field will be transferred to and from the GPS.
+     *  GPX does not place restrictions on the length of this field or the characters contained in it.
+     *  It is up to the receiving application to validate the field before sending it to the GPS. */
+    public static final String GPX_NAME = "name";
+
+    /** GPS element comment. Sent to GPS as comment. */
+    public static final String GPX_CMT = "cmt";
+
+    /** Text description of the element. Holds additional information about the element intended for the user, not the GPS. */
+    public static final String GPX_DESC = "desc";
+
+    /** Source of data. Included to give user some idea of reliability and accuracy of data. */
+    public static final String GPX_SRC = "src";
 
     public static final String META_PREFIX = "meta.";
@@ -28 +43 @@
     public static final String JOSM_EXTENSIONS_NAMESPACE_URI = Main.getXMLBase() + "/gpx-extensions-1.0";
 
-    public static List<String> WPT_KEYS = Arrays.asList("ele", "time", "magvar", "geoidheight",
-            "name", "cmt", "desc", "src", META_LINKS, "sym", "number", "type",
-            "fix", "sat", "hdop", "vdop", "pdop", "ageofdgpsdata", "dgpsid", META_EXTENSIONS);
+    /** Elevation (in meters) of the point. */
+    public static final String PT_ELE = "ele";
 
+    /** Creation/modification timestamp for the point.
+     *  Date and time in are in Univeral Coordinated Time (UTC), not local time!
+     *  Conforms to ISO 8601 specification for date/time representation.
+     *  Fractional seconds are allowed for millisecond timing in tracklogs. */
+    public static final String PT_TIME = "time";
+
+    /** Magnetic variation (in degrees) at the point. 0.0 <= value < 360.0 */
+    public static final String PT_MAGVAR = "magvar";
+
+    /** Height, in meters, of geoid (mean sea level) above WGS-84 earth ellipsoid. (NMEA GGA message) */
+    public static final String PT_GEOIDHEIGHT = "geoidheight";
+
+    /** Text of GPS symbol name. For interchange with other programs, use the exact spelling of the symbol on the GPS, if known. */
+    public static final String PT_SYM = "sym";
+
+    /** Type (textual classification) of element. */
+    public static final String PT_TYPE = "type";
+
+    /** Type of GPS fix. none means GPS had no fix. Value comes from list: {'none'|'2d'|'3d'|'dgps'|'pps'} */
+    public static final String PT_FIX = "fix";
+
+    /** Number of satellites used to calculate the GPS fix. (not number of satellites in view). */
+    public static final String PT_SAT = "sat";
+
+    /** Horizontal dilution of precision. */
+    public static final String PT_HDOP = "hdop";
+
+    /** Vertical dilution of precision. */
+    public static final String PT_VDOP = "vdop";
+
+    /** Position dilution of precision. */
+    public static final String PT_PDOP = "pdop";
+
+    /** Number of seconds since last DGPS update. */
+    public static final String PT_AGEOFDGPSDATA = "ageofdgpsdata";
+
+    /** Represents a differential GPS station. 0 <= value <= 1023 */
+    public static final String PT_DGPSID = "dgpsid";
+
+    /**
+     * Ordered list of all possible waypoint keys.
+     */
+    public static List<String> WPT_KEYS = Arrays.asList(PT_ELE, PT_TIME, PT_MAGVAR, PT_GEOIDHEIGHT,
+            GPX_NAME, GPX_CMT, GPX_DESC, GPX_SRC, META_LINKS, PT_SYM, PT_TYPE,
+            PT_FIX, PT_SAT, PT_HDOP, PT_VDOP, PT_PDOP, PT_AGEOFDGPSDATA, PT_DGPSID, META_EXTENSIONS);
+
+    /**
+     * Ordered list of all possible route and track keys.
+     */
+    public static List<String> RTE_TRK_KEYS = Arrays.asList(
+            GPX_NAME, GPX_CMT, GPX_DESC, GPX_SRC, META_LINKS, "number", PT_TYPE, META_EXTENSIONS);
+
+    /**
+     * Possible fix values.
+     */
+    public static Collection<String> FIX_VALUES = Arrays.asList("none","2d","3d","dgps","pps");
 }

trunk/src/org/openstreetmap/josm/data/gpx/GpxData.java

@@ -41 +41 @@
             String k = ent.getKey();
             if (k.equals(META_LINKS) && attr.containsKey(META_LINKS)) {
-                @SuppressWarnings("unchecked")
-                Collection<GpxLink> my = (Collection<GpxLink>) attr.get(META_LINKS);
+                Collection<GpxLink> my = super.<GpxLink>getCollection(META_LINKS);
                 @SuppressWarnings("unchecked")
                 Collection<GpxLink> their = (Collection<GpxLink>) ent.getValue();
                 my.addAll(their);
             } else {
-                attr.put(k, ent.getValue());
+                put(k, ent.getValue());
             }
         }

trunk/src/org/openstreetmap/josm/data/gpx/GpxLink.java

@@ -2 +2 @@
 package org.openstreetmap.josm.data.gpx;
 
+/**
+ * A link to an external resource (Web page, digital photo, video clip, etc) with additional information.
+ * @since 444
+ */
 public class GpxLink {
+
+    /** External resource URI */
     public String uri;
+
+    /** Text to display on the hyperlink */
     public String text;
+
+    /** Link type */
     public String type;
 
+    /**
+     * Constructs a new {@code GpxLink}.
+     * @param uri External resource URI
+     */
     public GpxLink(String uri) {
         this.uri = uri;

trunk/src/org/openstreetmap/josm/data/gpx/IWithAttributes.java

@@ -37 +37 @@
      * @since 5502
      */
-    Collection<?> getCollection(String key);
+    <T> Collection<T> getCollection(String key);
 
     /**

trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java

@@ -95 +95 @@
     @Override
     public String toString() {
-        return "WayPoint (" + (attr.containsKey("name") ? attr.get("name") + ", " :"") + getCoor().toString() + ", " + attr + ")";
+        return "WayPoint (" + (attr.containsKey(GPX_NAME) ? get(GPX_NAME) + ", " :"") + getCoor().toString() + ", " + attr + ")";
     }
 
@@ -102 +102 @@
      */
     public void setTime() {
-        if(attr.containsKey("time")) {
+        if (attr.containsKey(PT_TIME)) {
             try {
-                time = dateParser.get().parse(attr.get("time").toString()).getTime() / 1000.; /* ms => seconds */
+                time = dateParser.get().parse(get(PT_TIME).toString()).getTime() / 1000.; /* ms => seconds */
             } catch(Exception e) {
                 time = 0;
@@ -123 +123 @@
     public Object getTemplateValue(String name, boolean special) {
         if (!special)
-            return attr.get(name);
+            return get(name);
         else
             return null;

trunk/src/org/openstreetmap/josm/data/gpx/WithAttributes.java

@@ -56 +56 @@
      * @since 5502
      */
+    @SuppressWarnings("unchecked")
     @Override
-    public Collection<?> getCollection(String key) {
+    public <T> Collection<T> getCollection(String key) {
         Object value = attr.get(key);
-        return (value instanceof Collection) ? (Collection<?>)value : null;
+        return (value instanceof Collection) ? (Collection<T>)value : null;
     }