Changeset 1811 in josm for trunk/src/org/openstreetmap/josm/io/OsmServerBackreferenceReader.java

Timestamp:

2009-07-19T17:38:55+02:00 (15 years ago)

Author:

jttt

Message:

PleaseWait refactoring. Progress is now reported using ProgressMonitor interface, that is available through PleaseWaitRunnable.

File:

• trunk/src/org/openstreetmap/josm/io/OsmServerBackreferenceReader.java (modified) (16 diffs)

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

@@ -8 +8 @@
 import java.util.Collection;
 
-import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
@@ -15 +14 @@
 import org.openstreetmap.josm.data.osm.Way;
 import org.openstreetmap.josm.data.osm.visitor.MergeVisitor;
+import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 
 /**
@@ -21 +21 @@
  * which refer to the node. For a {@see Way} or a {@see Relation}, only relations are
  * read.
- * 
+ *
  * OsmServerBackreferenceReader uses the API calls <code>[node|way|relation]/#id/relations</code>
  * and  <code>node/#id/ways</code> to retrieve the referring primitives. The default behaviour
  * of these calls is to reply incomplete primitives only.
- * 
+ *
  * If you set {@see #setReadFull(boolean)} to true this reader uses a {@see MultiFetchServerObjectReader}
  * to complete incomplete primitives.
- * 
+ *
  *
  */
@@ -42 +42 @@
     /**
      * constructor
-     * 
+     *
      * @param primitive  the primitive to be read. Must not be null. primitive.id > 0 expected
-     * 
+     *
      * @exception IllegalArgumentException thrown if primitive is null
      * @exception IllegalArgumentException thrown if primitive.id <= 0
@@ -60 +60 @@
     /**
      * constructor
-     * 
+     *
      * @param id  the id of the primitive. > 0 expected
      * @param type the type of the primitive. Must not be null.
-     * 
+     *
      * @exception IllegalArgumentException thrown if id <= 0
      * @exception IllegalArgumentException thrown if type is null
-     * 
+     *
      */
     public OsmServerBackreferenceReader(long id, OsmPrimitiveType type) throws IllegalArgumentException   {
@@ -80 +80 @@
     /**
      * constructor
-     * 
+     *
      * @param id  the id of the primitive. > 0 expected
      * @param type the type of the primitive. Must not be null.
      * @param readFull true, if referers should be read fully (i.e. including their immediate children)
-     * 
+     *
      */
     public OsmServerBackreferenceReader(OsmPrimitive primitive, boolean readFull) {
@@ -93 +93 @@
     /**
      * constructor
-     * 
+     *
      * @param primitive the primitive whose referers are to be read
      * @param readFull true, if referers should be read fully (i.e. including their immediate children)
-     * 
+     *
      * @exception IllegalArgumentException thrown if id <= 0
      * @exception IllegalArgumentException thrown if type is null
-     * 
+     *
      */
     public OsmServerBackreferenceReader(long id, OsmPrimitiveType type, boolean readFull) throws IllegalArgumentException  {
@@ -108 +108 @@
     /**
      * Replies true if this reader also reads immediate children of referring primitives
-     * 
+     *
      * @return true if this reader also reads immediate children of referring primitives
      */
@@ -117 +117 @@
     /**
      * Set true if this reader should reads immediate children of referring primitives too. False, otherweise.
-     * 
+     *
      * @param readFull true if this reader should reads immediate children of referring primitives too. False, otherweise.
      */
@@ -126 +126 @@
     /**
      * Reads referring ways from the API server and replies them in a {@see DataSet}
-     * 
+     *
      * @return the data set
      * @throws OsmTransferException
      */
-    protected DataSet getReferringWays() throws OsmTransferException {
+    protected DataSet getReferringWays(ProgressMonitor progressMonitor) throws OsmTransferException {
         InputStream in = null;
-        try {
-            Main.pleaseWaitDlg.progress.setValue(0);
-            Main.pleaseWaitDlg.currentAction.setText(tr("Contacting OSM Server..."));
+        progressMonitor.beginTask(null, 2);
+        try {
+            progressMonitor.indeterminateSubTask(tr("Contacting OSM Server..."));
             StringBuffer sb = new StringBuffer();
             sb.append(primitiveType.getAPIName())
             .append("/").append(id).append("/ways");
 
-            in = getInputStream(sb.toString(), Main.pleaseWaitDlg);
+            in = getInputStream(sb.toString(), progressMonitor.createSubTaskMonitor(1, true));
             if (in == null)
                 return null;
-            Main.pleaseWaitDlg.currentAction.setText(tr("Downloading referring ways ..."));
-            return OsmReader.parseDataSet(in,Main.pleaseWaitDlg);
+            progressMonitor.subTask(tr("Downloading referring ways ..."));
+            return OsmReader.parseDataSet(in, progressMonitor.createSubTaskMonitor(1, true));
         } catch(OsmTransferException e) {
             throw e;
@@ -151 +151 @@
             throw new OsmTransferException(e);
         } finally {
+            progressMonitor.finishTask();
             if (in != null) {
                 try {
@@ -162 +163 @@
 
      * Reads referring relations from the API server and replies them in a {@see DataSet}
-     * 
+     *
      * @return the data set
      * @throws OsmTransferException
      */
-    protected DataSet getReferringRelations() throws OsmTransferException {
+    protected DataSet getReferringRelations(ProgressMonitor progressMonitor) throws OsmTransferException {
         InputStream in = null;
-        try {
-            Main.pleaseWaitDlg.progress.setValue(0);
-            Main.pleaseWaitDlg.currentAction.setText(tr("Contacting OSM Server..."));
+        progressMonitor.beginTask(null, 2);
+        try {
+            progressMonitor.subTask(tr("Contacting OSM Server..."));
             StringBuffer sb = new StringBuffer();
             sb.append(primitiveType.getAPIName())
             .append("/").append(id).append("/relations");
 
-            in = getInputStream(sb.toString(), Main.pleaseWaitDlg);
+            in = getInputStream(sb.toString(), progressMonitor.createSubTaskMonitor(1, true));
             if (in == null)
                 return null;
-            Main.pleaseWaitDlg.currentAction.setText(tr("Downloading referring relations ..."));
-            return OsmReader.parseDataSet(in,Main.pleaseWaitDlg);
+            progressMonitor.subTask(tr("Downloading referring relations ..."));
+            return OsmReader.parseDataSet(in, progressMonitor.createSubTaskMonitor(1, true));
         } catch(OsmTransferException e) {
             throw e;
@@ -187 +188 @@
             throw new OsmTransferException(e);
         } finally {
+            progressMonitor.finishTask();
             if (in != null) {
                 try {
@@ -200 +202 @@
      * incomplete primitives are read from the server with an individual <tt>/api/0.6/[way,relation]/#id/full</tt>
      * request.
-     * 
+     *
      * <ul>
      *   <li>if this reader reads referers for an {@see Node}, referring ways are always
@@ -207 +209 @@
      *    are only read fully if {@see #setReadFull(boolean)} is set to true.</li>
      * </ul>
-     * 
+     *
      * The method replies the modified dataset.
-     * 
+     *
      * @param ds the original dataset
      * @return the modified dataset
      * @throws OsmTransferException thrown if an exception occurs.
      */
-    protected DataSet readIncompletePrimitives(DataSet ds) throws OsmTransferException {
-        Collection<Way> waysToCheck = new ArrayList<Way>(ds.ways);
-        if (isReadFull() ||primitiveType.equals(OsmPrimitiveType.NODE)) {
-            for (Way way: waysToCheck) {
-                if (way.id > 0 && way.incomplete) {
-                    OsmServerObjectReader reader = new OsmServerObjectReader(way.id, OsmPrimitiveType.from(way), true /* read full */);
-                    DataSet wayDs = reader.parseOsm();
-                    MergeVisitor visitor = new MergeVisitor(ds, wayDs);
-                    visitor.merge();
+    protected DataSet readIncompletePrimitives(DataSet ds, ProgressMonitor progressMonitor) throws OsmTransferException {
+        progressMonitor.beginTask(null, 2);
+        try {
+            Collection<Way> waysToCheck = new ArrayList<Way>(ds.ways);
+            if (isReadFull() ||primitiveType.equals(OsmPrimitiveType.NODE)) {
+                for (Way way: waysToCheck) {
+                    if (way.id > 0 && way.incomplete) {
+                        OsmServerObjectReader reader = new OsmServerObjectReader(way.id, OsmPrimitiveType.from(way), true /* read full */);
+                        DataSet wayDs = reader.parseOsm(progressMonitor.createSubTaskMonitor(1, false));
+                        MergeVisitor visitor = new MergeVisitor(ds, wayDs);
+                        visitor.merge();
+                    }
                 }
             }
-        }
-        if (isReadFull()) {
-            Collection<Relation> relationsToCheck  = new ArrayList<Relation>(ds.relations);
-            for (Relation relation: relationsToCheck) {
-                if (relation.id > 0 && relation.incomplete) {
-                    OsmServerObjectReader reader = new OsmServerObjectReader(relation.id, OsmPrimitiveType.from(relation), true /* read full */);
-                    DataSet wayDs = reader.parseOsm();
-                    MergeVisitor visitor = new MergeVisitor(ds, wayDs);
-                    visitor.merge();
+            if (isReadFull()) {
+                Collection<Relation> relationsToCheck  = new ArrayList<Relation>(ds.relations);
+                for (Relation relation: relationsToCheck) {
+                    if (relation.id > 0 && relation.incomplete) {
+                        OsmServerObjectReader reader = new OsmServerObjectReader(relation.id, OsmPrimitiveType.from(relation), true /* read full */);
+                        DataSet wayDs = reader.parseOsm(progressMonitor.createSubTaskMonitor(1, false));
+                        MergeVisitor visitor = new MergeVisitor(ds, wayDs);
+                        visitor.merge();
+                    }
                 }
             }
-        }
-        return ds;
+            return ds;
+        } finally {
+            progressMonitor.finishTask();
+        }
     }
 
@@ -243 +250 @@
      * Reads the referring primitives from the OSM server, parses them and
      * replies them as {@see DataSet}
-     * 
+     *
      * @return the dataset with the referring primitives
      * @exception OsmTransferException thrown if an error occurs while communicating with the server
      */
     @Override
-    public DataSet parseOsm() throws OsmTransferException {
-        DataSet ret = new DataSet();
-        if (primitiveType.equals(OsmPrimitiveType.NODE)) {
-            DataSet ds = getReferringWays();
+    public DataSet parseOsm(ProgressMonitor progressMonitor) throws OsmTransferException {
+        progressMonitor.beginTask(null, 3);
+        try {
+            DataSet ret = new DataSet();
+            if (primitiveType.equals(OsmPrimitiveType.NODE)) {
+                DataSet ds = getReferringWays(progressMonitor.createSubTaskMonitor(1, false));
+                MergeVisitor visitor = new MergeVisitor(ret,ds);
+                visitor.merge();
+                ret = visitor.getMyDataSet();
+            }
+            DataSet ds = getReferringRelations(progressMonitor.createSubTaskMonitor(1, false));
             MergeVisitor visitor = new MergeVisitor(ret,ds);
             visitor.merge();
             ret = visitor.getMyDataSet();
-        }
-        DataSet ds = getReferringRelations();
-        MergeVisitor visitor = new MergeVisitor(ret,ds);
-        visitor.merge();
-        ret = visitor.getMyDataSet();
-        readIncompletePrimitives(ret);
-        return ret;
+            readIncompletePrimitives(ret, progressMonitor.createSubTaskMonitor(1, false));
+            return ret;
+        } finally {
+            progressMonitor.finishTask();
+        }
     }
 }