source: josm/trunk/src/org/openstreetmap/josm/io/session/SessionWriter.java@ 8620

Last change on this file since 8620 was 8620, checked in by wiktorn, 9 years ago

autozoom checkbox display fix in right-menu click

  • proper display of state of checkbox on right-click menu (autoZoom, autoLoad, showErrors)
  • add WMTS layer to session exporter
  • Property svn:eol-style set to native
File size: 10.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.io.session;
3
4import java.io.BufferedOutputStream;
5import java.io.File;
6import java.io.FileNotFoundException;
7import java.io.FileOutputStream;
8import java.io.IOException;
9import java.io.OutputStream;
10import java.io.OutputStreamWriter;
11import java.lang.reflect.Constructor;
12import java.nio.charset.StandardCharsets;
13import java.util.ArrayList;
14import java.util.HashMap;
15import java.util.List;
16import java.util.Map;
17import java.util.Set;
18import java.util.zip.ZipEntry;
19import java.util.zip.ZipOutputStream;
20
21import javax.xml.parsers.DocumentBuilder;
22import javax.xml.parsers.DocumentBuilderFactory;
23import javax.xml.parsers.ParserConfigurationException;
24import javax.xml.transform.OutputKeys;
25import javax.xml.transform.Transformer;
26import javax.xml.transform.TransformerException;
27import javax.xml.transform.TransformerFactory;
28import javax.xml.transform.dom.DOMSource;
29import javax.xml.transform.stream.StreamResult;
30
31import org.openstreetmap.josm.Main;
32import org.openstreetmap.josm.data.coor.EastNorth;
33import org.openstreetmap.josm.data.coor.LatLon;
34import org.openstreetmap.josm.data.projection.Projections;
35import org.openstreetmap.josm.gui.layer.GpxLayer;
36import org.openstreetmap.josm.gui.layer.Layer;
37import org.openstreetmap.josm.gui.layer.OsmDataLayer;
38import org.openstreetmap.josm.gui.layer.TMSLayer;
39import org.openstreetmap.josm.gui.layer.WMSLayer;
40import org.openstreetmap.josm.gui.layer.WMTSLayer;
41import org.openstreetmap.josm.gui.layer.geoimage.GeoImageLayer;
42import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer;
43import org.openstreetmap.josm.tools.MultiMap;
44import org.openstreetmap.josm.tools.Utils;
45import org.w3c.dom.Document;
46import org.w3c.dom.Element;
47import org.w3c.dom.Text;
48
49public class SessionWriter {
50
51 private static Map<Class<? extends Layer>, Class<? extends SessionLayerExporter>> sessionLayerExporters = new HashMap<>();
52
53 static {
54 registerSessionLayerExporter(OsmDataLayer.class , OsmDataSessionExporter.class);
55 registerSessionLayerExporter(TMSLayer.class , ImagerySessionExporter.class);
56 registerSessionLayerExporter(WMSLayer.class , ImagerySessionExporter.class);
57 registerSessionLayerExporter(WMTSLayer.class , ImagerySessionExporter.class);
58 registerSessionLayerExporter(GpxLayer.class , GpxTracksSessionExporter.class);
59 registerSessionLayerExporter(GeoImageLayer.class , GeoImageSessionExporter.class);
60 registerSessionLayerExporter(MarkerLayer.class, MarkerSessionExporter.class);
61 }
62
63 /**
64 * Register a session layer exporter.
65 *
66 * The exporter class must have an one-argument constructor with layerClass as formal parameter type.
67 */
68 public static void registerSessionLayerExporter(Class<? extends Layer> layerClass, Class<? extends SessionLayerExporter> exporter) {
69 sessionLayerExporters.put(layerClass, exporter);
70 }
71
72 public static SessionLayerExporter getSessionLayerExporter(Layer layer) {
73 Class<? extends Layer> layerClass = layer.getClass();
74 Class<? extends SessionLayerExporter> exporterClass = sessionLayerExporters.get(layerClass);
75 if (exporterClass == null) return null;
76 try {
77 Constructor<? extends SessionLayerExporter> constructor = exporterClass.getConstructor(layerClass);
78 return constructor.newInstance(layer);
79 } catch (Exception e) {
80 throw new RuntimeException(e);
81 }
82 }
83
84 private final List<Layer> layers;
85 private final int active;
86 private final Map<Layer, SessionLayerExporter> exporters;
87 private final MultiMap<Layer, Layer> dependencies;
88 private final boolean zip;
89
90 private ZipOutputStream zipOut;
91
92 /**
93 * Constructs a new {@code SessionWriter}.
94 * @param layers The ordered list of layers to save
95 * @param active The index of active layer in {@code layers} (starts to 0). Ignored if set to -1
96 * @param exporters The exporters to use to save layers
97 * @param zip {@code true} if a joz archive has to be created, {@code false otherwise}
98 * @since 6271
99 */
100 public SessionWriter(List<Layer> layers, int active, Map<Layer, SessionLayerExporter> exporters,
101 MultiMap<Layer, Layer> dependencies, boolean zip) {
102 this.layers = layers;
103 this.active = active;
104 this.exporters = exporters;
105 this.dependencies = dependencies;
106 this.zip = zip;
107 }
108
109 /**
110 * A class that provides some context for the individual {@link SessionLayerExporter}
111 * when doing the export.
112 */
113 public class ExportSupport {
114 private Document doc;
115 private int layerIndex;
116
117 public ExportSupport(Document doc, int layerIndex) {
118 this.doc = doc;
119 this.layerIndex = layerIndex;
120 }
121
122 public Element createElement(String name) {
123 return doc.createElement(name);
124 }
125
126 public Text createTextNode(String text) {
127 return doc.createTextNode(text);
128 }
129
130 /**
131 * Get the index of the layer that is currently exported.
132 * @return the index of the layer that is currently exported
133 */
134 public int getLayerIndex() {
135 return layerIndex;
136 }
137
138 /**
139 * Create a file inside the zip archive.
140 *
141 * @param zipPath the path inside the zip archive, e.g. "layers/03/data.xml"
142 * @return the OutputStream you can write to. Never close the returned
143 * output stream, but make sure to flush buffers.
144 */
145 public OutputStream getOutputStreamZip(String zipPath) throws IOException {
146 if (!isZip()) throw new RuntimeException();
147 ZipEntry entry = new ZipEntry(zipPath);
148 zipOut.putNextEntry(entry);
149 return zipOut;
150 }
151
152 /**
153 * Check, if the session is exported as a zip archive.
154 *
155 * @return true, if the session is exported as a zip archive (.joz file
156 * extension). It will always return true, if one of the
157 * {@link SessionLayerExporter} returns true for the
158 * {@link SessionLayerExporter#requiresZip()} method. Otherwise, the
159 * user can decide in the file chooser dialog.
160 */
161 public boolean isZip() {
162 return zip;
163 }
164 }
165
166 public Document createJosDocument() throws IOException {
167 DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
168 builderFactory.setValidating(false);
169 builderFactory.setNamespaceAware(true);
170 DocumentBuilder builder = null;
171 try {
172 builder = builderFactory.newDocumentBuilder();
173 } catch (ParserConfigurationException e) {
174 throw new RuntimeException(e);
175 }
176 Document doc = builder.newDocument();
177
178 Element root = doc.createElement("josm-session");
179 root.setAttribute("version", "0.1");
180 doc.appendChild(root);
181
182 Element viewportEl = doc.createElement("viewport");
183 root.appendChild(viewportEl);
184 Element centerEl = doc.createElement("center");
185 viewportEl.appendChild(centerEl);
186 EastNorth center = Main.map.mapView.getCenter();
187 LatLon centerLL = Projections.inverseProject(center);
188 centerEl.setAttribute("lat", Double.toString(centerLL.lat()));
189 centerEl.setAttribute("lon", Double.toString(centerLL.lon()));
190 Element scale = doc.createElement("scale");
191 viewportEl.appendChild(scale);
192 double dist100px = Main.map.mapView.getDist100Pixel();
193 scale.setAttribute("meter-per-pixel", Double.toString(dist100px / 100));
194
195 Element layersEl = doc.createElement("layers");
196 if (active >= 0) {
197 layersEl.setAttribute("active", Integer.toString(active+1));
198 }
199 root.appendChild(layersEl);
200
201 for (int index = 0; index < layers.size(); ++index) {
202 Layer layer = layers.get(index);
203 SessionLayerExporter exporter = exporters.get(layer);
204 ExportSupport support = new ExportSupport(doc, index+1);
205 Element el = exporter.export(support);
206 el.setAttribute("index", Integer.toString(index+1));
207 el.setAttribute("name", layer.getName());
208 el.setAttribute("visible", Boolean.toString(layer.isVisible()));
209 if (!Utils.equalsEpsilon(layer.getOpacity(), 1.0)) {
210 el.setAttribute("opacity", Double.toString(layer.getOpacity()));
211 }
212 Set<Layer> deps = dependencies.get(layer);
213 if (deps != null && !deps.isEmpty()) {
214 List<Integer> depsInt = new ArrayList<>();
215 for (Layer depLayer : deps) {
216 int depIndex = layers.indexOf(depLayer);
217 if (depIndex == -1) throw new AssertionError();
218 depsInt.add(depIndex+1);
219 }
220 el.setAttribute("depends", Utils.join(",", depsInt));
221 }
222 layersEl.appendChild(el);
223 }
224 return doc;
225 }
226
227 public void writeJos(Document doc, OutputStream out) throws IOException {
228 try {
229 OutputStreamWriter writer = new OutputStreamWriter(out, StandardCharsets.UTF_8);
230 writer.write("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
231 TransformerFactory transfac = TransformerFactory.newInstance();
232 Transformer trans = transfac.newTransformer();
233 trans.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
234 trans.setOutputProperty(OutputKeys.INDENT, "yes");
235 trans.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
236 StreamResult result = new StreamResult(writer);
237 DOMSource source = new DOMSource(doc);
238 trans.transform(source, result);
239 } catch (TransformerException e) {
240 throw new RuntimeException(e);
241 }
242 }
243
244 public void write(File f) throws IOException {
245 try (OutputStream out = new FileOutputStream(f)) {
246 write(out);
247 } catch (FileNotFoundException e) {
248 throw new IOException(e);
249 }
250 }
251
252 public void write(OutputStream out) throws IOException {
253 if (zip) {
254 zipOut = new ZipOutputStream(new BufferedOutputStream(out), StandardCharsets.UTF_8);
255 }
256 Document doc = createJosDocument(); // as side effect, files may be added to zipOut
257 if (zip) {
258 ZipEntry entry = new ZipEntry("session.jos");
259 zipOut.putNextEntry(entry);
260 writeJos(doc, zipOut);
261 Utils.close(zipOut);
262 } else {
263 writeJos(doc, new BufferedOutputStream(out));
264 }
265 }
266}
Note: See TracBrowser for help on using the repository browser.