Changeset 13733 in josm for trunk/src/org/openstreetmap/josm/data/imagery/DefaultLayer.java

Timestamp:

2018-05-12T14:18:57+02:00 (6 years ago)

Author:

wiktorn

Message:

Imagery definition refactor

Extend imagery definitions by:

• allowing setting default layers for WMS_ENDPOINT and WMTS
• allowing setting minimum expires time for tile for this imagery
• allowing setting custom headers that will be sent for all requests

(get map, get capabilities) for this imagery

Additional changes in code:

• use TileJobOptions to pass miscellaneous options to loaders
• refactor WMSImagery to use SAX parser

See: #15981, #7953, #16224, #15940, #16249

File:

• trunk/src/org/openstreetmap/josm/data/imagery/DefaultLayer.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/imagery/DefaultLayer.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.data.imagery;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import javax.json.Json;
+import javax.json.JsonObject;
+import javax.json.JsonObjectBuilder;
+
+import org.openstreetmap.josm.data.imagery.ImageryInfo.ImageryType;
 
 /**
@@ -12 +20 @@
  */
 public class DefaultLayer {
-
-    protected String layerName;
+    private final String layerName;
+    private final String tileMatrixSet;
+    private final String style;
 
     /**
      * Constructor
-     * @param layerName that is the DefaultLayer
+     * @param imageryType for which this layer is defined
+     * @param layerName as returned by getIdentifier for WMTS and getName for WMS
+     * @param style of the layer
+     * @param tileMatrixSet only for WMTS - tileMatrixSet to use
      */
-    public DefaultLayer(String layerName) {
-        this.layerName = layerName;
+    public DefaultLayer(ImageryType imageryType, String layerName, String style, String tileMatrixSet) {
+        this.layerName = layerName == null ? "" : layerName;
+        this.style = style == null ? "" : style;
+        if (!imageryType.equals(ImageryType.WMTS) && !(tileMatrixSet == null || "".equals(tileMatrixSet))) {
+            throw new IllegalArgumentException(tr("{0} imagery has tileMatrixSet defined to: {1}", imageryType, tileMatrixSet));
+        }
+        this.tileMatrixSet = tileMatrixSet == null ? "" : tileMatrixSet;
     }
 
@@ -30 +47 @@
     }
 
+    /**
+     * @return default tileMatrixSet. Only usable for WMTS
+     */
+    public String getTileMatrixSet() {
+        return tileMatrixSet;
+    }
+
+    /**
+     * @return style for this WMS / WMTS layer to use
+     */
+    public String getStyle() {
+        return style;
+    }
+
+    /**
+     * @return JSON representation of the default layer object
+     */
+    public JsonObject toJson() {
+        JsonObjectBuilder ret = Json.createObjectBuilder();
+        ret.add("layerName", layerName);
+        ret.add("style", style);
+        ret.add("tileMatrixSet", tileMatrixSet);
+        return ret.build();
+    }
+
+    /**
+     * Factory method creating DefaultLayer from JSON objects
+     * @param o serialized DefaultLayer object
+     * @param type of ImageryType serialized
+     * @return DefaultLayer instance based on JSON object
+     */
+    public static DefaultLayer fromJson(JsonObject o, ImageryType type) {
+        return new DefaultLayer(type, o.getString("layerName"), o.getString("style"), o.getString("tileMatrixSet"));
+    }
 }