Source: util/LevelRowColumnUrlBuilder.js

  1. /*
  2.  * Copyright 2003-2006, 2009, 2017, 2020 United States Government, as represented
  3.  * by the Administrator of the National Aeronautics and Space Administration.
  4.  * All rights reserved.
  5.  *
  6.  * The NASAWorldWind/WebWorldWind platform is licensed under the Apache License,
  7.  * Version 2.0 (the "License"); you may not use this file except in compliance
  8.  * with the License. You may obtain a copy of the License
  9.  * at http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software distributed
  12.  * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  13.  * CONDITIONS OF ANY KIND, either express or implied. See the License for the
  14.  * specific language governing permissions and limitations under the License.
  15.  *
  16.  * NASAWorldWind/WebWorldWind also contains the following 3rd party Open Source
  17.  * software:
  18.  *
  19.  *    ES6-Promise – under MIT License
  20.  *    libtess.js – SGI Free Software License B
  21.  *    Proj4 – under MIT License
  22.  *    JSZip – under MIT License
  23.  *
  24.  * A complete listing of 3rd Party software notices and licenses included in
  25.  * WebWorldWind can be found in the WebWorldWind 3rd-party notices and licenses
  26.  * PDF found in code  directory.
  27.  */
  28. /**
  29.  * @exports LevelRowColumnUrlBuilder
  30.  */
  31. define([
  32.         '../error/ArgumentError',
  33.         '../util/Logger',
  34.         '../util/WWUtil'
  35.     ],
  36.     function (ArgumentError,
  37.               Logger,
  38.               WWUtil) {
  39.         "use strict";
  41.         /**
  42.          * Constructs a URL builder for level/row/column tiles.
  43.          * @alias LevelRowColumnUrlBuilder
  44.          * @constructor
  45.          * @classdesc Provides a factory to create URLs for level/row/column tile REST requests.
  46.          * <p>
  47.          * URLs are formed by appending the specified server address with the specified path and appending
  48.          * a path of the form <em>/level/row/row_column.image-format</em>, where image-format is the corresponding
  49.          * suffix to the image mime type specified when a URL is requested. For example, if the specified server
  50.          * address is <em>https://worldwind32.arc.nasa.gov</em> and the specified path-to-data is
  51.          * <em>../standalonedata/Earth/BlueMarble256</em>, and the requested tile's level, row and column are 0, 5 and 9
  52.          * respectively, and the image format is <em>image/jpeg</em>, the composed URL is
  53.          * <em>https://worldwind32.arc.nasa.gov/standalonedata/Earth/BlueMarble256/0/5/5_9.jpg</em>.
  54.          *
  55.          * @param {String} serverAddress The server address. May be null, in which case the address is assumed to be
  56.          * the current location (see <code>window.location</code>) minus the last path component.
  57.          * @param {String} pathToData The path to the dataset on the server. May be null or empty to indicate that
  58.          * the data is directly relative to the specified server address.
  59.          *
  60.          */
  61.         var LevelRowColumnUrlBuilder = function (serverAddress, pathToData) {
  62.             /**
  63.              * The server address.
  64.              * @type {String}
  65.              */
  66.             this.serverAddress = serverAddress;
  67.             if (!serverAddress || serverAddress.length === 0) {
  68.                 this.serverAddress = WWUtil.currentUrlSansFilePart();
  69.             }
  71.             /**
  72.              * The server-side path to the dataset.
  73.              * @type {String}
  74.              */
  75.             this.pathToData = pathToData;
  76.         };
  78.         /**
  79.          * Creates the URL string for a WMS Get Map request.
  80.          * @param {Tile} tile The tile for which to create the URL.
  81.          * @param {String} imageFormat The image format to request.
  82.          * @throws {ArgumentError} If the specified tile or image format are null or undefined.
  83.          */
  84.         LevelRowColumnUrlBuilder.prototype.urlForTile = function (tile, imageFormat) {
  85.             if (!tile) {
  86.                 throw new ArgumentError(
  87.                     Logger.logMessage(Logger.LEVEL_SEVERE, "WmsUrlBuilder", "urlForTile", "missingTile"));
  88.             }
  90.             if (!imageFormat) {
  91.                 throw new ArgumentError(
  92.                     Logger.logMessage(Logger.LEVEL_SEVERE, "WmsUrlBuilder", "urlForTile",
  93.                         "The image format is null or undefined."));
  94.             }
  96.             var sb = this.serverAddress;
  98.             if (this.pathToData) {
  99.                 sb = sb + "/" + this.pathToData;
  100.             }
  102.             sb = sb + "/" + tile.level.levelNumber.toString();
  103.             sb = sb + "/" + tile.row.toString();
  104.             sb = sb + "/" + tile.row.toString() + "_" + tile.column.toString();
  105.             sb = sb + "." + WWUtil.suffixForMimeType(imageFormat);
  107.             sb = sb.replace(" ", "%20");
  109.             return sb;
  110.         };
  112.         return LevelRowColumnUrlBuilder;
  113.     });