Changeset 2604 in josm for trunk/src/org/openstreetmap/josm/io/OsmChangeBuilder.java

Timestamp:

2009-12-10T18:42:41+01:00 (14 years ago)

Author:

Gubaer

Message:

New: JOSM reading, writing, merging changeset attribute
fixed #4090: Add changeset:* search option to JOSM's search engine

File:

• trunk/src/org/openstreetmap/josm/io/OsmChangeBuilder.java (moved) (moved from trunk/src/org/openstreetmap/josm/data/osm/visitor/CreateOsmChangeVisitor.java ) (5 diffs)

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

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.data.osm.visitor;
+package org.openstreetmap.josm.io;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
-import java.util.Map;
+import java.util.Collection;
 
 import org.openstreetmap.josm.data.osm.Changeset;
-import org.openstreetmap.josm.data.osm.Node;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
-import org.openstreetmap.josm.data.osm.Relation;
-import org.openstreetmap.josm.data.osm.Way;
-import org.openstreetmap.josm.io.OsmApi;
-import org.openstreetmap.josm.io.OsmWriter;
 
 /**
@@ -19 +16 @@
  * OsmChange format.
  *
- * @author fred
- *
  */
-public class CreateOsmChangeVisitor extends AbstractVisitor {
+public class OsmChangeBuilder {
+    static public final String DEFAULT_API_VERSION = "0.6";
 
     private String currentMode;
@@ -28 +24 @@
     private StringWriter swriter;
     private OsmWriter osmwriter;
-    private OsmApi api;
+    private String apiVersion = DEFAULT_API_VERSION;
+    private boolean prologWritten = false;
 
-    public CreateOsmChangeVisitor(Changeset changeset, OsmApi api) {
+    public OsmChangeBuilder(Changeset changeset) {
+        this(changeset, null /* default api version */);
+    }
+
+    public OsmChangeBuilder(Changeset changeset, String apiVersion) {
+        this.apiVersion = apiVersion == null ? DEFAULT_API_VERSION : apiVersion;
         writer = new PrintWriter(swriter = new StringWriter());
-        writer.write("<osmChange version=\"");
-        writer.write(api.getVersion());
-        writer.write("\" generator=\"JOSM\">\n");
-        this.api = api;
-        // need to set osmConform = false here so that negative IDs get transmitted.
-        // this also enables unnecessary and (if the API were more strict) potentially
-        // harmful action="..." attributes.
-        osmwriter = new OsmWriter(writer, false, api.getVersion());
+        osmwriter = new OsmWriter(writer, false, apiVersion);
         osmwriter.setChangeset(changeset);
     }
 
-    // FIXME: This should really NOT use a visitor pattern, it looks
-    // stupid. Just have one method named "write" instead of three "visit"s.
-
-    public void visit(Node n) {
-        if (n.isDeleted()) {
+    protected void write(OsmPrimitive p) {
+        if (p.isDeleted()) {
             switchMode("delete");
             osmwriter.setWithBody(false);
-            osmwriter.visit(n);
+            p.visit(osmwriter);
         } else {
-            switchMode(n.isNew() ? "create" : "modify");
+            switchMode(p.isNew() ? "create" : "modify");
             osmwriter.setWithBody(true);
-            osmwriter.visit(n);
-        }
-    }
-    public void visit(Way w) {
-        if (w.isDeleted()) {
-            switchMode("delete");
-            osmwriter.setWithBody(false);
-            osmwriter.visit(w);
-        } else {
-            switchMode(w.isNew() ? "create" : "modify");
-            osmwriter.setWithBody(true);
-            osmwriter.visit(w);
-        }
-    }
-    public void visit(Relation r) {
-        if (r.isDeleted()) {
-            switchMode("delete");
-            osmwriter.setWithBody(false);
-            osmwriter.visit(r);
-        } else {
-            switchMode(r.isNew() ? "create" : "modify");
-            osmwriter.setWithBody(true);
-            osmwriter.visit(r);
+            p.visit(osmwriter);
         }
     }
@@ -83 +53 @@
         if ((newMode != null && !newMode.equals(currentMode))||(newMode == null && currentMode != null)) {
             if (currentMode != null) {
-                writer.write("</");
-                writer.write(currentMode);
-                writer.write(">\n");
+                writer.print("</");
+                writer.print(currentMode);
+                writer.println(">");
             }
             if (newMode != null) {
-                writer.write("<");
-                writer.write(newMode);
-                writer.write(" version=\"");
-                writer.write(api.getVersion());
-                writer.write("\" generator=\"JOSM\">\n");
+                writer.print("<");
+                writer.print(newMode);
+                writer.println(">");
             }
             currentMode = newMode;
@@ -98 +66 @@
     }
 
-    public String getDocument() {
-        switchMode(null);
-        return swriter.toString() + "</osmChange>\n";
+    /**
+     * Writes the prolog of the OsmChange document
+     * 
+     * @throws IllegalStateException thrown if the prologs has already been written
+     */
+    public void start() throws IllegalStateException{
+        if (prologWritten)
+            throw new IllegalStateException(tr("Prolog of OsmChange document already written. Please write only once."));
+        writer.print("<osmChange version=\"");
+        writer.print(apiVersion);
+        writer.println("\" generator=\"JOSM\">");
+        prologWritten=true;
     }
 
-    public Map<OsmPrimitive,Long> getNewIdMap() {
-        return osmwriter.usedNewIds;
+    /**
+     * Appends a collection of {@see OsmPrimitive}s to the OsmChange document.
+     * 
+     * @param primitives the collection of primitives. Ignored if null.
+     * @throws IllegalStateException thrown if the prologs has not been written yet
+     * @see #start()
+     * @see #append(OsmPrimitive)
+     */
+    public void append(Collection<OsmPrimitive> primitives) throws IllegalStateException{
+        if (primitives == null) return;
+        if (!prologWritten)
+            throw new IllegalStateException(tr("Prolog of OsmChange document not written yet. Please write frst."));
+        for (OsmPrimitive p : primitives) {
+            write(p);
+        }
+    }
+
+    /**
+     * Appends an {@see OsmPrimitive} to the OsmChange document.
+     * 
+     * @param p the primitive. Ignored if null.
+     * @throws IllegalStateException thrown if the prologs has not been written yet
+     * @see #start()
+     * @see #append(Collection)
+
+     */
+    public void append(OsmPrimitive p) {
+        if (p == null) return;
+        if (!prologWritten)
+            throw new IllegalStateException(tr("Prolog of OsmChange document not written yet. Please write frst."));
+        write(p);
+    }
+
+    /**
+     * Writes the epilog of the OsmChange document
+     * 
+     * @throws IllegalStateException thrown if the prologs has not been written yet
+     */
+    public void finish() throws IllegalStateException {
+        if (!prologWritten)
+            throw new IllegalStateException(tr("Prolog of OsmChange document not written yet. Please write frst."));
+        if (currentMode != null) {
+            writer.print("</");
+            writer.print(currentMode);
+            writer.println(">");
+        }
+        writer.println("</osmChange>");
+    }
+
+    public String getDocument() {
+        return swriter.toString();
     }
 }