Source: formats/geojson/GeoJSONFeature.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 GeoJSONFeature
  30.  */
  31. define(['../../error/ArgumentError',
  32.         './GeoJSONConstants',
  33.         '../../util/Logger'
  34.     ],
  35.     function (ArgumentError,
  36.               GeoJSONConstants,
  37.               Logger) {
  38.         "use strict";
  40.         /**
  41.          * Constructs a GeoJSON Feature object. Applications typically do not call this constructor. It is called by
  42.          * {@link GeoJSON} as GeoJSON is read.
  43.          * @alias GeoJSONFeature
  44.          * @constructor
  45.          * @classdesc Contains the data associated with a GeoJSON Feature Object.
  46.          * A feature object must have a member with the name "geometry".
  47.          * The value of the geometry member is a geometry object or a JSON null value.
  48.          * A feature object must have a member with the name "properties".
  49.          * The value of the properties member is an object (any JSON object or a JSON null value).
  50.          * If a feature has a commonly used identifier, that identifier should be included as a member of the
  51.          * feature object with the name "id".
  52.          * To include information on the coordinate range for features, a GeoJSON object may have a member
  53.          * named "bbox".
  54.          * @param {Object} geometry An object containing the value of GeoJSON geometry member.
  55.          * @param {Object} properties An object containing the value of GeoJSON properties member.
  56.          * @param {Object} id An object containing the value of GeoJSON Feature id member.
  57.          * @param {Object} bbox An object containing the value of GeoJSON Feature bbox member.
  58.          * @throws {ArgumentError} If the specified mandatory geometries or properties are null or undefined.
  59.          */
  60.         var GeoJSONFeature = function (geometry, properties, id, bbox) {
  62.             if (!geometry) {
  63.                 throw new ArgumentError(
  64.                     Logger.logMessage(Logger.LEVEL_SEVERE, "GeoJSONFeature", "constructor",
  65.                         "missingGeometry"));
  66.             }
  68.             if (!geometry[GeoJSONConstants.FIELD_TYPE]) {
  69.                 throw new ArgumentError(
  70.                     Logger.logMessage(Logger.LEVEL_SEVERE, "GeoJSONFeature", "constructor",
  71.                         "missingFeatureGeometryType"));
  72.             }
  74.             if (!properties) {
  75.                 throw new ArgumentError(
  76.                     Logger.logMessage(Logger.LEVEL_SEVERE, "GeoJSONFeature", "constructor",
  77.                         "missingProperties"));
  78.             }
  80.             // Documented in defineProperties below.
  81.             this._geometry = geometry;
  83.             // Documented in defineProperties below.
  84.             this._properties =  properties;
  86.             // Documented in defineProperties below.
  87.             this._id = id;
  89.             // Documented in defineProperties below.
  90.             this._bbox = bbox;
  91.         };
  93.         Object.defineProperties(GeoJSONFeature.prototype, {
  94.             /**
  95.              * The GeoJSON Feature geometry as specified to this GeoJSONFeature's constructor.
  96.              * @memberof GeoJSONFeature.prototype
  97.              * @type {Object}
  98.              * @readonly
  99.              */
  100.             geometry: {
  101.                 get: function () {
  102.                     return this._geometry;
  103.                 }
  104.             },
  105.             /**
  106.              * The GeoJSON Feature properties as specified to this GeoJSONFeature's constructor.
  107.              * @memberof GeoJSONFeature.prototype
  108.              * @type {Object}
  109.              * @readonly
  110.              */
  111.             properties: {
  112.                 get: function () {
  113.                     return this._properties;
  114.                 }
  115.             },
  116.             /**
  117.              * The GeoJSON Feature id as specified to this GeoJSONFeature's constructor.
  118.              * @memberof GeoJSONFeature.prototype
  119.              * @type {Object}
  120.              * @readonly
  121.              */
  122.             id: {
  123.                 get: function () {
  124.                     return this._id;
  125.                 }
  126.             },
  127.             /**
  128.              * The GeoJSON Feature bbox member as specified to this GeoJSONFeature's constructor.
  129.              * @memberof GeoJSONFeature.prototype
  130.              * @type {Object}
  131.              * @readonly
  132.              */
  133.             bbox: {
  134.                 get: function () {
  135.                     return this._bbox;
  136.                 }
  137.             }
  138.         });
  140.         return GeoJSONFeature;
  141. });