source: josm/trunk/src/org/openstreetmap/josm/io/OsmWriter.java@ 12803

Last change on this file since 12803 was 12802, checked in by Don-vip, 7 years ago

see #14794 - checkstyle (unit tests)
  • Property svn:eol-style set to native
File size: 12.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.io;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.io.PrintWriter;
7import java.util.ArrayList;
8import java.util.Collection;
9import java.util.Comparator;
10import java.util.Date;
11import java.util.List;
12import java.util.Map.Entry;
13
14import org.openstreetmap.josm.data.DataSource;
15import org.openstreetmap.josm.data.coor.LatLon;
16import org.openstreetmap.josm.data.coor.conversion.DecimalDegreesCoordinateFormat;
17import org.openstreetmap.josm.data.osm.AbstractPrimitive;
18import org.openstreetmap.josm.data.osm.Changeset;
19import org.openstreetmap.josm.data.osm.DataSet;
20import org.openstreetmap.josm.data.osm.DataSet.UploadPolicy;
21import org.openstreetmap.josm.data.osm.INode;
22import org.openstreetmap.josm.data.osm.IPrimitive;
23import org.openstreetmap.josm.data.osm.IRelation;
24import org.openstreetmap.josm.data.osm.IWay;
25import org.openstreetmap.josm.data.osm.Node;
26import org.openstreetmap.josm.data.osm.OsmPrimitive;
27import org.openstreetmap.josm.data.osm.Relation;
28import org.openstreetmap.josm.data.osm.Tagged;
29import org.openstreetmap.josm.data.osm.Way;
30import org.openstreetmap.josm.data.osm.visitor.PrimitiveVisitor;
31import org.openstreetmap.josm.gui.layer.OsmDataLayer;
32import org.openstreetmap.josm.tools.date.DateUtils;
33
34/**
35 * Save the dataset into a stream as osm intern xml format. This is not using any xml library for storing.
36 * @author imi
37 * @since 59
38 */
39public class OsmWriter extends XmlWriter implements PrimitiveVisitor {
40
41 /** Default OSM API version */
42 public static final String DEFAULT_API_VERSION = "0.6";
43
44 private final boolean osmConform;
45 private boolean withBody = true;
46 private boolean withVisible = true;
47 private boolean isOsmChange;
48 private String version;
49 private Changeset changeset;
50
51 /**
52 * Constructs a new {@code OsmWriter}.
53 * Do not call this directly. Use {@link OsmWriterFactory} instead.
54 * @param out print writer
55 * @param osmConform if {@code true}, prevents modification attributes to be written to the common part
56 * @param version OSM API version (0.6)
57 */
58 protected OsmWriter(PrintWriter out, boolean osmConform, String version) {
59 super(out);
60 this.osmConform = osmConform;
61 this.version = version == null ? DEFAULT_API_VERSION : version;
62 }
63
64 /**
65 * Sets whether body must be written.
66 * @param wb if {@code true} body will be written.
67 */
68 public void setWithBody(boolean wb) {
69 this.withBody = wb;
70 }
71
72 /**
73 * Sets whether 'visible' attribute must be written.
74 * @param wv if {@code true} 'visible' attribute will be written.
75 * @since 12019
76 */
77 public void setWithVisible(boolean wv) {
78 this.withVisible = wv;
79 }
80
81 public void setIsOsmChange(boolean isOsmChange) {
82 this.isOsmChange = isOsmChange;
83 }
84
85 public void setChangeset(Changeset cs) {
86 this.changeset = cs;
87 }
88
89 public void setVersion(String v) {
90 this.version = v;
91 }
92
93 public void header() {
94 header(UploadPolicy.NORMAL);
95 }
96
97 public void header(UploadPolicy upload) {
98 out.println("<?xml version='1.0' encoding='UTF-8'?>");
99 out.print("<osm version='");
100 out.print(version);
101 if (upload != null && upload != UploadPolicy.NORMAL) {
102 out.print("' upload='");
103 out.print(upload.getXmlFlag());
104 }
105 out.println("' generator='JOSM'>");
106 }
107
108 public void footer() {
109 out.println("</osm>");
110 }
111
112 /**
113 * Sorts {@code -1} &rarr; {@code -infinity}, then {@code +1} &rarr; {@code +infinity}
114 */
115 protected static final Comparator<AbstractPrimitive> byIdComparator = (o1, o2) -> {
116 final long i1 = o1.getUniqueId();
117 final long i2 = o2.getUniqueId();
118 if (i1 < 0 && i2 < 0) {
119 return Long.compare(i2, i1);
120 } else {
121 return Long.compare(i1, i2);
122 }
123 };
124
125 protected <T extends OsmPrimitive> Collection<T> sortById(Collection<T> primitives) {
126 List<T> result = new ArrayList<>(primitives.size());
127 result.addAll(primitives);
128 result.sort(byIdComparator);
129 return result;
130 }
131
132 /**
133 * Writes the full OSM file for the given layer (header, data sources, osm data, footer).
134 * @param layer OSM data layer
135 * @deprecated To be removed end of 2017. Use {@link #write(DataSet)} instead
136 */
137 @Deprecated
138 public void writeLayer(OsmDataLayer layer) {
139 write(layer.data);
140 }
141
142 /**
143 * Writes the full OSM file for the given data set (header, data sources, osm data, footer).
144 * @param data OSM data set
145 * @since 12800
146 */
147 public void write(DataSet data) {
148 header(data.getUploadPolicy());
149 writeDataSources(data);
150 writeContent(data);
151 footer();
152 }
153
154 /**
155 * Writes the contents of the given dataset (nodes, then ways, then relations)
156 * @param ds The dataset to write
157 */
158 public void writeContent(DataSet ds) {
159 setWithVisible(UploadPolicy.NORMAL.equals(ds.getUploadPolicy()));
160 writeNodes(ds.getNodes());
161 writeWays(ds.getWays());
162 writeRelations(ds.getRelations());
163 }
164
165 /**
166 * Writes the given nodes sorted by id
167 * @param nodes The nodes to write
168 * @since 5737
169 */
170 public void writeNodes(Collection<Node> nodes) {
171 for (Node n : sortById(nodes)) {
172 if (shouldWrite(n)) {
173 visit(n);
174 }
175 }
176 }
177
178 /**
179 * Writes the given ways sorted by id
180 * @param ways The ways to write
181 * @since 5737
182 */
183 public void writeWays(Collection<Way> ways) {
184 for (Way w : sortById(ways)) {
185 if (shouldWrite(w)) {
186 visit(w);
187 }
188 }
189 }
190
191 /**
192 * Writes the given relations sorted by id
193 * @param relations The relations to write
194 * @since 5737
195 */
196 public void writeRelations(Collection<Relation> relations) {
197 for (Relation r : sortById(relations)) {
198 if (shouldWrite(r)) {
199 visit(r);
200 }
201 }
202 }
203
204 protected boolean shouldWrite(OsmPrimitive osm) {
205 return !osm.isNewOrUndeleted() || !osm.isDeleted();
206 }
207
208 public void writeDataSources(DataSet ds) {
209 for (DataSource s : ds.getDataSources()) {
210 out.println(" <bounds minlat='"
211 + DecimalDegreesCoordinateFormat.INSTANCE.latToString(s.bounds.getMin())
212 +"' minlon='"
213 + DecimalDegreesCoordinateFormat.INSTANCE.lonToString(s.bounds.getMin())
214 +"' maxlat='"
215 + DecimalDegreesCoordinateFormat.INSTANCE.latToString(s.bounds.getMax())
216 +"' maxlon='"
217 + DecimalDegreesCoordinateFormat.INSTANCE.lonToString(s.bounds.getMax())
218 +"' origin='"+XmlWriter.encode(s.origin)+"' />");
219 }
220 }
221
222 void writeLatLon(LatLon ll) {
223 if (ll != null) {
224 out.print(" lat='"+LatLon.cDdHighPecisionFormatter.format(ll.lat())+
225 "' lon='"+LatLon.cDdHighPecisionFormatter.format(ll.lon())+'\'');
226 }
227 }
228
229 @Override
230 public void visit(INode n) {
231 if (n.isIncomplete()) return;
232 addCommon(n, "node");
233 if (!withBody) {
234 out.println("/>");
235 } else {
236 writeLatLon(n.getCoor());
237 addTags(n, "node", true);
238 }
239 }
240
241 @Override
242 public void visit(IWay w) {
243 if (w.isIncomplete()) return;
244 addCommon(w, "way");
245 if (!withBody) {
246 out.println("/>");
247 } else {
248 out.println(">");
249 for (int i = 0; i < w.getNodesCount(); ++i) {
250 out.println(" <nd ref='"+w.getNodeId(i) +"' />");
251 }
252 addTags(w, "way", false);
253 }
254 }
255
256 @Override
257 public void visit(IRelation e) {
258 if (e.isIncomplete()) return;
259 addCommon(e, "relation");
260 if (!withBody) {
261 out.println("/>");
262 } else {
263 out.println(">");
264 for (int i = 0; i < e.getMembersCount(); ++i) {
265 out.print(" <member type='");
266 out.print(e.getMemberType(i).getAPIName());
267 out.println("' ref='"+e.getMemberId(i)+"' role='" +
268 XmlWriter.encode(e.getRole(i)) + "' />");
269 }
270 addTags(e, "relation", false);
271 }
272 }
273
274 public void visit(Changeset cs) {
275 out.print(" <changeset id='"+cs.getId()+'\'');
276 if (cs.getUser() != null) {
277 out.print(" user='"+ XmlWriter.encode(cs.getUser().getName()) +'\'');
278 out.print(" uid='"+cs.getUser().getId() +'\'');
279 }
280 Date createdDate = cs.getCreatedAt();
281 if (createdDate != null) {
282 out.print(" created_at='"+DateUtils.fromDate(createdDate) +'\'');
283 }
284 Date closedDate = cs.getClosedAt();
285 if (closedDate != null) {
286 out.print(" closed_at='"+DateUtils.fromDate(closedDate) +'\'');
287 }
288 out.print(" open='"+ (cs.isOpen() ? "true" : "false") +'\'');
289 if (cs.getMin() != null) {
290 out.print(" min_lon='"+ DecimalDegreesCoordinateFormat.INSTANCE.lonToString(cs.getMin()) +'\'');
291 out.print(" min_lat='"+ DecimalDegreesCoordinateFormat.INSTANCE.latToString(cs.getMin()) +'\'');
292 }
293 if (cs.getMax() != null) {
294 out.print(" max_lon='"+ DecimalDegreesCoordinateFormat.INSTANCE.lonToString(cs.getMin()) +'\'');
295 out.print(" max_lat='"+ DecimalDegreesCoordinateFormat.INSTANCE.latToString(cs.getMin()) +'\'');
296 }
297 out.println(">");
298 addTags(cs, "changeset", false); // also writes closing </changeset>
299 }
300
301 protected static final Comparator<Entry<String, String>> byKeyComparator = (o1, o2) -> o1.getKey().compareTo(o2.getKey());
302
303 protected void addTags(Tagged osm, String tagname, boolean tagOpen) {
304 if (osm.hasKeys()) {
305 if (tagOpen) {
306 out.println(">");
307 }
308 List<Entry<String, String>> entries = new ArrayList<>(osm.getKeys().entrySet());
309 entries.sort(byKeyComparator);
310 for (Entry<String, String> e : entries) {
311 out.println(" <tag k='"+ XmlWriter.encode(e.getKey()) +
312 "' v='"+XmlWriter.encode(e.getValue())+ "' />");
313 }
314 out.println(" </" + tagname + '>');
315 } else if (tagOpen) {
316 out.println(" />");
317 } else {
318 out.println(" </" + tagname + '>');
319 }
320 }
321
322 /**
323 * Add the common part as the form of the tag as well as the XML attributes
324 * id, action, user, and visible.
325 * @param osm osm primitive
326 * @param tagname XML tag matching osm primitive (node, way, relation)
327 */
328 protected void addCommon(IPrimitive osm, String tagname) {
329 out.print(" <"+tagname);
330 if (osm.getUniqueId() != 0) {
331 out.print(" id='"+ osm.getUniqueId()+'\'');
332 } else
333 throw new IllegalStateException(tr("Unexpected id 0 for osm primitive found"));
334 if (!isOsmChange) {
335 if (!osmConform) {
336 String action = null;
337 if (osm.isDeleted()) {
338 action = "delete";
339 } else if (osm.isModified()) {
340 action = "modify";
341 }
342 if (action != null) {
343 out.print(" action='"+action+'\'');
344 }
345 }
346 if (!osm.isTimestampEmpty()) {
347 out.print(" timestamp='"+DateUtils.fromTimestamp(osm.getRawTimestamp())+'\'');
348 }
349 // user and visible added with 0.4 API
350 if (osm.getUser() != null) {
351 if (osm.getUser().isLocalUser()) {
352 out.print(" user='"+XmlWriter.encode(osm.getUser().getName())+'\'');
353 } else if (osm.getUser().isOsmUser()) {
354 // uid added with 0.6
355 out.print(" uid='"+ osm.getUser().getId()+'\'');
356 out.print(" user='"+XmlWriter.encode(osm.getUser().getName())+'\'');
357 }
358 }
359 if (withVisible) {
360 out.print(" visible='"+osm.isVisible()+'\'');
361 }
362 }
363 if (osm.getVersion() != 0) {
364 out.print(" version='"+osm.getVersion()+'\'');
365 }
366 if (this.changeset != null && this.changeset.getId() != 0) {
367 out.print(" changeset='"+this.changeset.getId()+'\'');
368 } else if (osm.getChangesetId() > 0 && !osm.isNew()) {
369 out.print(" changeset='"+osm.getChangesetId()+'\'');
370 }
371 }
372}
Note: See TracBrowser for help on using the repository browser.