Source: map-common/src/main/resources/META-INF/resources/js/GeoJSONBase.es.js

  1. /**
  2.  * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
  3.  *
  4.  * This library is free software; you can redistribute it and/or modify it under
  5.  * the terms of the GNU Lesser General Public License as published by the Free
  6.  * Software Foundation; either version 2.1 of the License, or (at your option)
  7.  * any later version.
  8.  *
  9.  * This library is distributed in the hope that it will be useful, but WITHOUT
  10.  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11.  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  12.  * details.
  13.  */
  15. import State, {Config} from 'metal-state';
  17. /**
  18.  * GeoJSONBase
  19.  * Allows adding controls (called features) to the map, that produce
  20.  * diverse actions. For example, a button for centering the map
  21.  * view will act as a feature.
  22.  * @abstract
  23.  * @review
  24.  */
  25. class GeoJSONBase extends State {
  27. 	/**
  28. 	 * Receives an object with native features data and tries
  29. 	 * to parse it with the implemented method _getNativeFeatures.
  30. 	 * If the generated Array of native features is not empty, it fires
  31. 	 * a 'featuresAdded' event.
  32. 	 * @param {Object} nativeFeaturesData Data to be processed.
  33. 	 * @review
  34. 	 */
  35. 	addData(nativeFeaturesData) {
  36. 		const nativeFeatures = this._getNativeFeatures(nativeFeaturesData);
  38. 		if (nativeFeatures.length > 0) {
  39. 			this.emit('featuresAdded', {
  40. 				features: nativeFeatures.map(this._wrapNativeFeature),
  41. 			});
  42. 		}
  43. 	}
  45. 	/**
  46. 	 * Callback executed when a native feature has been clicked.
  47. 	 * It receives the feature as parameter, and emits a 'featureClick'
  48. 	 * event with the wrapped feature as event data.
  49. 	 * @param {Object} nativeFeature Feature to be wrapped and sent
  50. 	 * @protected
  51. 	 * @review
  52. 	 */
  53. 	_handleFeatureClicked(nativeFeature) {
  54. 		this.emit('featureClick', {
  55. 			feature: this._wrapNativeFeature(nativeFeature),
  56. 		});
  57. 	}
  59. 	/**
  60. 	 * Parses an object and return an array of the
  61. 	 * parsed features. If no feature has been parsed it may return an
  62. 	 * empty array.
  63. 	 * @abstract
  64. 	 * @param {Object} nativeFeaturesData
  65. 	 * @protected
  66. 	 * @return {Object[]} List of native features to be added
  67. 	 * @review
  68. 	 */
  69. 	_getNativeFeatures(
  70. 		/* eslint-disable no-unused-vars */
  71. 		nativeFeaturesData
  72. 		/* eslint-enable no-unused-vars */
  73. 	) {
  74. 		throw new Error('Must be implemented');
  75. 	}
  77. 	/**
  78. 	 * Wraps a native feature.
  79. 	 * @abstract
  80. 	 * @param {Object} nativeFeature
  81. 	 * @protected
  82. 	 * @return {Object} Wrapped native feature
  83. 	 * @review
  84. 	 */
  85. 	_wrapNativeFeature(
  86. 		/* eslint-disable no-unused-vars */
  87. 		nativeFeature
  88. 		/* eslint-enable no-unused-vars */
  89. 	) {
  90. 		throw new Error('Must be implemented');
  91. 	}
  92. }
  94. /**
  95.  * State definition.
  96.  * @review
  97.  * @static
  98.  * @type {!Object}
  99.  */
  100. GeoJSONBase.STATE = {
  102. 	/**
  103. 	 * Map to be used
  104. 	 * @review
  105. 	 * @type {Object}
  106. 	 */
  107. 	map: Config.object(),
  108. };
  110. window.Liferay = window.Liferay || {};
  112. window.Liferay.MapGeojsonBase = GeoJSONBase;
  114. export default GeoJSONBase;
  115. export {GeoJSONBase};