Changeset 7704 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2014-11-04T02:33:20+01:00 (10 years ago)

Author:

Don-vip

Message:

see #10701 - parsing support of changeset discussions

Location:

trunk/src/org/openstreetmap/josm/io

Files:

• OsmChangesetParser.java (modified) (7 diffs)
• OsmServerChangesetReader.java (modified) (6 diffs)

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

@@ -8 +8 @@
 import java.nio.charset.StandardCharsets;
 import java.text.MessageFormat;
+import java.util.Date;
 import java.util.LinkedList;
 import java.util.List;
@@ -16 +17 @@
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.osm.Changeset;
+import org.openstreetmap.josm.data.osm.ChangesetDiscussionComment;
 import org.openstreetmap.josm.data.osm.User;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -70 +72 @@
         private Changeset current = null;
 
+        /** The current comment */
+        private ChangesetDiscussionComment comment = null;
+
+        /** The current comment text */
+        private StringBuilder text = null;
+
         protected void parseChangesetAttributes(Changeset cs, Attributes atts) throws XmlParsingException {
             // -- id
@@ -78 +86 @@
             current.setId(parseNumericAttribute(value, 1));
 
-            // -- user
-            String user = atts.getValue("user");
-            String uid = atts.getValue("uid");
-            current.setUser(createUser(uid, user));
+            // -- user / uid
+            current.setUser(createUser(atts));
 
             // -- created_at
@@ -155 +161 @@
         }
 
+        private void parseCommentAttributes(Attributes atts) throws XmlParsingException {
+            // -- date
+            String value = atts.getValue("date");
+            Date date = null;
+            if (value != null) {
+                date = DateUtils.fromString(value);
+            }
+
+            comment = new ChangesetDiscussionComment(date, createUser(atts));
+        }
+
         private int parseNumericAttribute(String value, int minAllowed) throws XmlParsingException {
             int att = 0;
@@ -193 +210 @@
                 current.put(key, value);
                 break;
+            case "discussion":
+                break;
+            case "comment":
+                parseCommentAttributes(atts);
+                break;
+            case "text":
+                text = new StringBuilder();
+                break;
             default:
                 throwException(tr("Undefined element ''{0}'' found in input stream. Aborting.", qName));
+            }
+        }
+
+        @Override
+        public void characters(char[] ch, int start, int length) throws SAXException {
+            if (text != null) {
+                text.append(ch, start, length);
             }
         }
@@ -202 +234 @@
             if ("changeset".equals(qName)) {
                 changesets.add(current);
-            }
-        }
-
-        protected User createUser(String uid, String name) throws XmlParsingException {
+                current = null;
+            } else if ("comment".equals(qName)) {
+                current.addDiscussionComment(comment);
+                comment = null;
+            } else if ("text".equals(qName)) {
+                comment.setText(text.toString());
+                text = null;
+            }
+        }
+
+        protected User createUser(Attributes atts) throws XmlParsingException {
+            String name = atts.getValue("user");
+            String uid = atts.getValue("uid");
             if (uid == null) {
                 if (name == null)

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

@@ -29 +29 @@
 
     /**
-     * constructor
-     *
-     */
-    public OsmServerChangesetReader(){
+     * Constructs a new {@code OsmServerChangesetReader}.
+     */
+    public OsmServerChangesetReader() {
         setDoAuthenticate(false);
     }
@@ -38 +37 @@
     /**
      * don't use - not implemented!
-     *
      */
     @Override
     public DataSet parseOsm(ProgressMonitor progressMonitor) throws OsmTransferException {
         return null;
+    }
+
+    protected final InputStream getChangesetInputStream(long id, boolean includeDiscussion, ProgressMonitor monitor)
+            throws OsmTransferException {
+        StringBuilder sb = new StringBuilder();
+        sb.append("changeset/").append(id);
+        if (includeDiscussion) {
+            sb.append("?include_discussion=true");
+        }
+        return getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true));
     }
 
@@ -82 +90 @@
 
     /**
-     * Reads the changeset with id <code>id</code> from the server
+     * Reads the changeset with id <code>id</code> from the server.
      *
-     * @param id  the changeset id. id &gt; 0 required.
+     * @param id the changeset id. id &gt; 0 required.
+     * @param includeDiscussion determines if discussion comments must be downloaded or not
      * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the changeset read
      * @throws OsmTransferException thrown if something goes wrong
      * @throws IllegalArgumentException if id &lt;= 0
-     */
-    public Changeset readChangeset(long id, ProgressMonitor monitor) throws OsmTransferException {
+     * @since 7704
+     */
+    public Changeset readChangeset(long id, boolean includeDiscussion, ProgressMonitor monitor) throws OsmTransferException {
         if (id <= 0)
             throw new IllegalArgumentException(MessageFormat.format("Parameter ''{0}'' > 0 expected. Got ''{1}''.", "id", id));
@@ -99 +109 @@
         try {
             monitor.beginTask(tr("Reading changeset {0} ...",id));
-            StringBuilder sb = new StringBuilder();
-            sb.append("changeset/").append(id);
-            try (InputStream in = getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true))) {
+            try (InputStream in = getChangesetInputStream(id, includeDiscussion, monitor)) {
                 if (in == null)
                     return null;
@@ -123 +131 @@
 
     /**
-     * Reads the changeset with id <code>id</code> from the server
+     * Reads the changesets with id <code>ids</code> from the server.
      *
-     * @param ids  the list of ids. Ignored if null. Only load changesets for ids &gt; 0.
+     * @param ids the list of ids. Ignored if null. Only load changesets for ids &gt; 0.
+     * @param includeDiscussion determines if discussion comments must be downloaded or not
      * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
      * @return the changeset read
      * @throws OsmTransferException thrown if something goes wrong
      * @throws IllegalArgumentException if id &lt;= 0
-     */
-    public List<Changeset> readChangesets(Collection<Integer> ids, ProgressMonitor monitor) throws OsmTransferException {
+     * @since 7704
+     */
+    public List<Changeset> readChangesets(Collection<Integer> ids, boolean includeDiscussion, ProgressMonitor monitor) throws OsmTransferException {
         if (ids == null)
             return Collections.emptyList();
@@ -147 +157 @@
                 }
                 i++;
-                StringBuilder sb = new StringBuilder();
-                sb.append("changeset/").append(id);
-                try (InputStream in = getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true))) {
+                try (InputStream in = getChangesetInputStream(id, includeDiscussion, monitor)) {
                     if (in == null)
                         return null;