Changeset 2563 in josm for trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java

Timestamp:

03.12.2009 19:02:25 (2 years ago)

Author:

Gubaer

Message:

fixed #3400: relation editor: improvement to highlight an element
fixed #3873: Feature request: download selected elements in relation editor
New: Dbl-Click in member table to set the map selection to this member
New: Ctrl-Dbl-Clik in member table to add the member to the the map selection
New: Download selected incomplete members only

File:

• trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java

@@ -9 +9 @@
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
+import org.openstreetmap.josm.data.osm.PrimitiveId;
+import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
+import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 import org.xml.sax.SAXException;
 
+/**
+ * OsmServerObjectReader reads an individual object from the OSM server.
+ * 
+ * It can either download the object including or not including its immediate children.
+ * The former case is called a "full download".
+ * 
+ */
 public class OsmServerObjectReader extends OsmServerReader {
+    /** the id of the object to download */
+    private PrimitiveId id;
+    /** true if a full download is required, i.e. a download including the immediate children */
+    private boolean full;
 
-    long id;
-    OsmPrimitiveType type;
-    boolean full;
-
-    public OsmServerObjectReader(long id, OsmPrimitiveType type, boolean full) {
-        this.id = id;
-        this.type = type;
+    /**
+     * Creates a new server object reader for a given id and a primitive type.
+     * 
+     * @param id the object id. > 0 required.
+     * @param type the type. Must not be null.
+     * @param full true, if a full download is requested (i.e. a download including
+     * immediate children); false, otherwise
+     * @throws IllegalArgumentException thrown if id <= 0
+     * @throws IllegalArgumentException thrown if type is null
+     */
+    public OsmServerObjectReader(long id, OsmPrimitiveType type, boolean full) throws IllegalArgumentException {
+        if (id <= 0)
+            throw new IllegalArgumentException(tr("Expected value > 0 for parameter ''{0}'', got {1}", "id", id));
+        if (type == null)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null", "type"));
+        this.id = new SimplePrimitiveId(id, type);
         this.full = full;
     }
+
     /**
-     * Method to download single objects from OSM server. ways, relations, nodes
-     * @return the data requested
+     * Creates a new server object reader for an object with the given <code>id</code>
+     * 
+     * @param id the object id. Must not be null. Unique id > 0 required.
+     * @param full true, if a full download is requested (i.e. a download including
+     * immediate children); false, otherwise
+     * @throws IllegalArgumentException thrown if id is null
+     * @throws IllegalArgumentException thrown if id.getUniqueId() <= 0
+     */
+    public OsmServerObjectReader(PrimitiveId id, boolean full) {
+        if (id == null)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null", "id"));
+        if (id.getUniqueId() <= 0)
+            throw new IllegalArgumentException(tr("Expected value > 0 for parameter ''{0}'', got {1}", "id.getUniqueId()", id.getUniqueId()));
+        this.id = id;
+        this.full = full;
+    }
+
+    /**
+     * Downloads and parses the data.
+     * 
+     * @param progressMonitor the progress monitor. Set to {@see NullProgressMonitor#INSTANCE} if
+     * null
+     * @return the downloaded data
      * @throws SAXException
      * @throws IOException
@@ -31 +76 @@
     @Override
     public DataSet parseOsm(ProgressMonitor progressMonitor) throws OsmTransferException {
+        if (progressMonitor == null) {
+            progressMonitor = NullProgressMonitor.INSTANCE;
+        }
         progressMonitor.beginTask("", 1);
         InputStream in = null;
@@ -36 +84 @@
             progressMonitor.indeterminateSubTask(tr("Downloading OSM data..."));
             StringBuffer sb = new StringBuffer();
-            sb.append(type.getAPIName());
+            sb.append(id.getType().getAPIName());
             sb.append("/");
-            sb.append(id);
-            if (full && ! type.equals(OsmPrimitiveType.NODE)) {
+            sb.append(id.getUniqueId());
+            if (full && ! id.getType().equals(OsmPrimitiveType.NODE)) {
                 sb.append("/full");
             }
@@ -59 +107 @@
                 try {
                     in.close();
-                } catch(Exception e) {}
+                } catch(Exception e) {/* ignore this exception */}
             }
             activeConnection = null;
         }
     }
-
 }