Changeset 1811 in josm for trunk/src/org/openstreetmap/josm/io/MultiFetchServerObjectReader.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/MultiFetchServerObjectReader.java (modified) (24 diffs)

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

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
-import java.io.IOException;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
@@ -14 +13 @@
 import java.util.logging.Logger;
 
-import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.osm.DataSet;
 import org.openstreetmap.josm.data.osm.Node;
@@ -23 +21 @@
 import org.openstreetmap.josm.data.osm.Way;
 import org.openstreetmap.josm.data.osm.visitor.MergeVisitor;
-import org.xml.sax.SAXException;
+import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
+import org.openstreetmap.josm.gui.progress.ProgressMonitor;
 
 /**
  * Retrieves a set of {@see OsmPrimitive}s from an OSM server using the so called
  * Multi Fetch API.
- * 
+ *
  * Usage:
  * <pre>
@@ -42 +41 @@
  *    }
  * </pre>
- * 
+ *
  *
  */
@@ -53 +52 @@
      * which should be safe according to the
      * <a href="http://www.boutell.com/newfaq/misc/urllength.html">WWW FAQ</a>.
-     * 
+     *
      */
     static private int MAX_IDS_PER_REQUEST = 200;
@@ -79 +78 @@
      * remembers an {@see OsmPrimitive}'s id and its type. The id will
      * later be fetched as part of a Multi Get request.
-     * 
+     *
      * Ignore the id if it id <= 0.
-     * 
+     *
      * @param id  the id
      * @param type  the type
@@ -100 +99 @@
      * an {@see OsmPrimitive} with id=<code>id</code>. The id will
      * later we fetched as part of a Multi Get request.
-     * 
+     *
      * Ignore the id if it id <= 0.
-     * 
+     *
      * @param ds  the dataset (must not be null)
      * @param id  the id
@@ -123 +122 @@
      * appends a list of  ids to the list of ids which will be fetched from the server. ds must
      * include an {@see OsmPrimitive} for each id in ids.
-     * 
+     *
      * id is ignored if id <= 0.
-     * 
+     *
      * @param ds  the dataset
      * @param ids  the list of ids
      * @return this
-     * 
+     *
      */
     public MultiFetchServerObjectReader append(DataSet ds, long ... ids)  {
@@ -142 +141 @@
      * appends a collection of  ids to the list of ids which will be fetched from the server. ds must
      * include an {@see OsmPrimitive} for each id in ids.
-     * 
+     *
      * id is ignored if id <= 0.
-     * 
+     *
      * @param ds  the dataset
      * @param ids  the collection of ids
      * @return this
-     * 
+     *
      */
     public MultiFetchServerObjectReader append(DataSet ds, Collection<Long> ids) {
@@ -163 +162 @@
      * @param node  the node (ignored, if null)
      * @return this
-     * 
+     *
      */
     public MultiFetchServerObjectReader append(Node node) {
@@ -177 +176 @@
      * @param way the way (ignored, if null)
      * @return this
-     * 
+     *
      */
     public MultiFetchServerObjectReader append(Way way) {
@@ -196 +195 @@
      * @param relation  the relation (ignored, if null)
      * @return this
-     * 
+     *
      */
     public MultiFetchServerObjectReader append(Relation relation) {
@@ -225 +224 @@
      * @param primitives  the list of primitives (ignored, if null)
      * @return this
-     * 
+     *
      * @see #append(Node)
      * @see #append(Way)
      * @see #append(Relation)
-     * 
+     *
      */
     public MultiFetchServerObjectReader append(Collection<OsmPrimitive> primitives) {
@@ -242 +241 @@
      * extracts a subset of max {@see #MAX_IDS_PER_REQUEST} ids from <code>ids</code> and
      * replies the subset. The extracted subset is removed from <code>ids</code>.
-     * 
+     *
      * @param ids a set of ids
      * @return the subset of ids
@@ -267 +266 @@
      * builds the Multi Get request string for a set of ids and a given
      * {@see OsmPrimitiveType}.
-     * 
+     *
      * @param type the type
      * @param idPackage  the package of ids
@@ -290 +289 @@
      * builds the Multi Get request string for a single id and a given
      * {@see OsmPrimitiveType}.
-     * 
+     *
      * @param type the type
      * @param id the id
@@ -306 +305 @@
      * invokes a Multi Get for a set of ids and a given {@see OsmPrimitiveType}.
      * The retrieved primitives are merged to {@see #outputDataSet}.
-     * 
+     *
      * @param type the type
      * @param pkg the package of ids
      * @exception OsmTransferException thrown if an error occurs while communicating with the API server
-     * 
-     */
-    protected void multiGetIdPackage(OsmPrimitiveType type, Set<Long> pkg) throws OsmTransferException {
+     *
+     */
+    protected void multiGetIdPackage(OsmPrimitiveType type, Set<Long> pkg, ProgressMonitor progressMonitor) throws OsmTransferException {
         String request = buildRequestString(type, pkg);
-        final InputStream in = getInputStream(request, Main.pleaseWaitDlg);
+        final InputStream in = getInputStream(request, NullProgressMonitor.INSTANCE);
         if (in == null) return;
-        Main.pleaseWaitDlg.currentAction.setText(tr("Downloading OSM data..."));
+        progressMonitor.subTask(tr("Downloading OSM data..."));
         try {
-            final OsmReader osm = OsmReader.parseDataSetOsm(in, Main.pleaseWaitDlg);
+            final OsmReader osm = OsmReader.parseDataSetOsm(in, progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false));
             merge(osm.getDs());
         } catch(Exception e) {
@@ -328 +327 @@
      * invokes a Multi Get for a single id and a given {@see OsmPrimitiveType}.
      * The retrieved primitive is merged to {@see #outputDataSet}.
-     * 
+     *
      * @param type the type
      * @param id the id
      * @exception OsmTransferException thrown if an error occurs while communicating with the API server
-     * 
-     */
-    protected void singleGetId(OsmPrimitiveType type, long id) throws OsmTransferException {
+     *
+     */
+    protected void singleGetId(OsmPrimitiveType type, long id, ProgressMonitor progressMonitor) throws OsmTransferException {
         String request = buildRequestString(type, id);
-        final InputStream in = getInputStream(request, Main.pleaseWaitDlg);
+        final InputStream in = getInputStream(request, NullProgressMonitor.INSTANCE);
         if (in == null)
             return;
-        Main.pleaseWaitDlg.currentAction.setText(tr("Downloading OSM data..."));
+        progressMonitor.subTask(tr("Downloading OSM data..."));
         try {
-            final OsmReader osm = OsmReader.parseDataSetOsm(in,Main.pleaseWaitDlg);
+            final OsmReader osm = OsmReader.parseDataSetOsm(in, progressMonitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false));
             merge(osm.getDs());
         } catch(Exception e) {
@@ -351 +350 @@
      * invokes a sequence of Multi Gets for individual ids in a set of ids and a given {@see OsmPrimitiveType}.
      * The retrieved primitives are merged to {@see #outputDataSet}.
-     * 
+     *
      * This method is used if one of the ids in pkg doesn't exist (the server replies with return code 404).
      * If the set is fetched with this method it is possible to find out which of the ids doesn't exist.
      * Unfortunatelly, the server does not provide an error header or an error body for a 404 reply.
-     * 
+     *
      * @param type the type
      * @param pkg the set of ids
      * @exception OsmTransferException thrown if an error occurs while communicating with the API server
-     * 
-     */
-    protected void singleGetIdPackage(OsmPrimitiveType type, Set<Long> pkg) throws OsmTransferException {
+     *
+     */
+    protected void singleGetIdPackage(OsmPrimitiveType type, Set<Long> pkg, ProgressMonitor progressMonitor) throws OsmTransferException {
         for (long id : pkg) {
             try {
-                singleGetId(type, id);
+                singleGetId(type, id, progressMonitor);
             } catch(OsmApiException e) {
                 if (e.getResponseCode() == HttpURLConnection.HTTP_NOT_FOUND) {
@@ -378 +377 @@
     /**
      * merges the dataset <code>from</code> to {@see #outputDataSet}.
-     * 
+     *
      * @param from the other dataset
-     * 
+     *
      */
     protected void merge(DataSet from) {
@@ -389 +388 @@
     /**
      * fetches a set of ids of a given {@see OsmPrimitiveType} from the server
-     * 
+     *
      * @param ids the set of ids
      * @param type the  type
      * @exception OsmTransferException thrown if an error occurs while communicating with the API server
      */
-    protected void fetchPrimitives(Set<Long> ids, OsmPrimitiveType type) throws OsmTransferException{
+    protected void fetchPrimitives(Set<Long> ids, OsmPrimitiveType type, ProgressMonitor progressMonitor) throws OsmTransferException{
         Set<Long> toFetch = new HashSet<Long>(ids);
         toFetch.addAll(ids);
@@ -400 +399 @@
             Set<Long> pkg = extractIdPackage(toFetch);
             try {
-                multiGetIdPackage(type, pkg);
+                multiGetIdPackage(type, pkg, progressMonitor);
             } catch(OsmApiException e) {
                 if (e.getResponseCode() == HttpURLConnection.HTTP_NOT_FOUND) {
                     logger.warning(tr("Server replied with response code 404, retrying with an individual request for each primitive"));
-                    singleGetIdPackage(type, pkg);
+                    singleGetIdPackage(type, pkg, progressMonitor);
                 } else
                     throw e;
@@ -417 +416 @@
      * the latest version of the primitive (if any), even if the primitive is not visible (i.e. if
      * visible==false).
-     * 
+     *
      * Invoke {@see #getMissingPrimitives()} to get a list of primitives which have not been
      * found on  the server (the server response code was 404)
-     * 
+     *
      * Invoke {@see #getSkippedWay()} to get a list of ways which this reader could not build from
      * the fetched data because the ways refer to nodes which don't exist on the server.
-     * 
+     *
      * @return the parsed data
      * @exception OsmTransferException thrown if an error occurs while communicating with the API server
      * @see #getMissingPrimitives()
      * @see #getSkippedWays()
-     * 
+     *
 
      */
     @Override
-    public DataSet parseOsm() throws OsmTransferException {
-        missingPrimitives = new HashSet<Long>();
-
-        fetchPrimitives(nodes,OsmPrimitiveType.NODE);
-        fetchPrimitives(ways,OsmPrimitiveType.WAY);
-        fetchPrimitives(relations,OsmPrimitiveType.RELATION);
-        return outputDataSet;
+    public DataSet parseOsm(ProgressMonitor progressMonitor) throws OsmTransferException {
+        progressMonitor.beginTask("");
+        try {
+            missingPrimitives = new HashSet<Long>();
+
+            fetchPrimitives(nodes,OsmPrimitiveType.NODE, progressMonitor);
+            fetchPrimitives(ways,OsmPrimitiveType.WAY, progressMonitor);
+            fetchPrimitives(relations,OsmPrimitiveType.RELATION, progressMonitor);
+            return outputDataSet;
+        } finally {
+            progressMonitor.finishTask();
+        }
     }
 
@@ -445 +449 @@
      * server was submitted but which are not available from the server (the server
      * replied a return code of 404)
-     * 
+     *
      * @return the set of ids of missing primitives
      */