Changeset 2689 in josm for trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java

Timestamp:

28.12.2009 00:16:04 (2 years ago)

Author:

Gubaer

Message:

new: Changeset Cache Manager for querying, downloading, browsing, and managing changesets within JOSM. See also Changeset Manager and Changeset Query Dialog

File:

• trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java (moved) (moved from trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/DownloadChangesetsTask.java) (6 diffs)

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetHeaderDownloadTask.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.awt.Component;
 import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Set;
 
 import javax.swing.SwingUtilities;
 
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.osm.Changeset;
 import org.openstreetmap.josm.data.osm.ChangesetCache;
@@ -18 +21 @@
 import org.openstreetmap.josm.io.OsmServerChangesetReader;
 import org.openstreetmap.josm.io.OsmTransferException;
+import org.openstreetmap.josm.tools.BugReportExceptionHandler;
+import org.openstreetmap.josm.tools.CheckParameterUtil;
+import org.openstreetmap.josm.tools.ExceptionUtil;
 import org.xml.sax.SAXException;
 
-public class DownloadChangesetsTask extends PleaseWaitRunnable{
+/**
+ * This is an asynchronous task for downloading a collection of changests from the OSM
+ * server.
+ * 
+ * The  task only downloads the changeset properties without the changeset content. It
+ * updates the global {@see ChangesetCache}.
+ * 
+ */
+public class ChangesetHeaderDownloadTask extends PleaseWaitRunnable implements ChangesetDownloadTask{
+
+    /**
+     * Builds a download task from for a collection of changesets.
+     * 
+     * Ignores null values and changesets with {@see Changeset#isNew()} == true.
+     * 
+     * @param changesets the collection of changesets. Assumes an empty collection if null.
+     * @return the download task
+     */
+    static public ChangesetHeaderDownloadTask buildTaskForChangesets(Collection<Changeset> changesets) {
+        return buildTaskForChangesets(Main.parent, changesets);
+    }
+
+    /**
+     * Builds a download task from for a collection of changesets.
+     * 
+     * Ignores null values and changesets with {@see Changeset#isNew()} == true.
+     * 
+     * @param parent the parent component relative to which the {@see PleaseWaitDialog} is displayed.
+     * Must not be null.
+     * @param changesets the collection of changesets. Assumes an empty collection if null.
+     * @return the download task
+     * @throws IllegalArgumentException thrown if parent is null
+     */
+    static public ChangesetHeaderDownloadTask buildTaskForChangesets(Component parent, Collection<Changeset> changesets) {
+        CheckParameterUtil.ensureParameterNotNull(parent, "parent");
+        if (changesets == null) {
+            changesets = Collections.emptyList();
+        }
+
+        HashSet<Integer> ids = new HashSet<Integer>();
+        for (Changeset cs: changesets) {
+            if (cs == null || cs.isNew()) {
+                continue;
+            }
+            ids.add(cs.getId());
+        }
+        if (parent == null)
+            return new ChangesetHeaderDownloadTask(ids);
+        else
+            return new ChangesetHeaderDownloadTask(parent, ids);
+
+    }
+
 
     private Set<Integer> idsToDownload;
     private OsmServerChangesetReader reader;
-    private boolean cancelled;
+    private boolean canceled;
     private Exception lastException;
-    private List<Changeset> downloadedChangesets;
-
-    public DownloadChangesetsTask(Collection<Integer> ids) {
-        super(tr("Download changesets"));
+    private Set<Changeset> downloadedChangesets;
+
+    protected void init(Collection<Integer> ids) {
+        if (ids == null) {
+            ids = Collections.emptyList();
+        }
         idsToDownload = new HashSet<Integer>();
         if (ids == null ||  ids.isEmpty())
@@ -41 +101 @@
     }
 
+    /**
+     * Creates the download task for a collection of changeset ids. Uses a {@see PleaseWaitDialog}
+     * whose parent is {@see Main#parent}.
+     * 
+     * Null ids or or ids <= 0 in the id collection are ignored.
+     * 
+     * @param ids the collection of ids. Empty collection assumed if null.
+     */
+    public ChangesetHeaderDownloadTask(Collection<Integer> ids) {
+        // parent for dialog is Main.parent
+        super(tr("Download changesets"), false /* don't ignore exceptions */);
+        init(ids);
+    }
+
+    /**
+     * Creates the download task for a collection of changeset ids. Uses a {@see PleaseWaitDialog}
+     * whose parent is the parent window of <code>dialogParent</code>.
+     * 
+     * Null ids or or ids <= 0 in the id collection are ignored.
+     * 
+     * @param dialogParent the parent reference component for the {@see PleaseWaitDialog}. Must not be null.
+     * @param ids the collection of ids. Empty collection assumed if null.
+     * @throws IllegalArgumentException thrown if dialogParent is null
+     */
+    public ChangesetHeaderDownloadTask(Component dialogParent, Collection<Integer> ids) throws IllegalArgumentException{
+        super(dialogParent,tr("Download changesets"), false /* don't ignore exceptions */);
+        init(ids);
+    }
+
     @Override
     protected void cancel() {
-        cancelled = true;
+        canceled = true;
         synchronized (this) {
             if (reader != null) {
@@ -53 +142 @@
     @Override
     protected void finish() {
-        if (cancelled)
+        if (canceled)
             return;
         if (lastException != null) {
@@ -67 +156 @@
             r.run();
         } else {
-            SwingUtilities.invokeLater(r);
+            try {
+                SwingUtilities.invokeAndWait(r);
+            } catch(InterruptedException e) {
+                e.printStackTrace();
+            } catch(InvocationTargetException e) {
+                Throwable t = e.getTargetException();
+                if (t instanceof RuntimeException) {
+                    BugReportExceptionHandler.handleException(t);
+                } else if (t instanceof Exception){
+                    ExceptionUtil.explainException(e);
+                } else {
+                    BugReportExceptionHandler.handleException(t);
+                }
+            }
         }
     }
@@ -77 +179 @@
                 reader = new OsmServerChangesetReader();
             }
-            downloadedChangesets = reader.readChangesets(idsToDownload, getProgressMonitor().createSubTaskMonitor(0, false));
-        } catch(Exception e) {
-            if (cancelled)
+            downloadedChangesets = new HashSet<Changeset>();
+            downloadedChangesets.addAll(reader.readChangesets(idsToDownload, getProgressMonitor().createSubTaskMonitor(0, false)));
+        } catch(OsmTransferException e) {
+            if (canceled)
                 // ignore exception if cancelled
                 return;
-            if (e instanceof RuntimeException)
-                throw (RuntimeException)e;
+            // remember other exceptions
             lastException = e;
         }
     }
+
+    /* ------------------------------------------------------------------------------- */
+    /* interface ChangesetDownloadTask                                                 */
+    /* ------------------------------------------------------------------------------- */
+    public Set<Changeset> getDownloadedChangesets() {
+        return downloadedChangesets;
+    }
+
+    public boolean isCanceled() {
+        return canceled;
+    }
+
+    public boolean isFailed() {
+        return lastException != null;
+    }
 }