Merge pull request #2951 from camptocamp/import-ds-01-restructuring

Import DataSource Restructuring (1)

contribs/gmf/examples/displayquerygrid.js

@@ -1,6 +1,6 @@
 goog.provide('gmfapp.displayquerygrid');
 
-goog.require('gmf.DataSourcesManager');
+goog.require('gmf.datasource.DataSourcesManager');
 goog.require('gmf.Themes');
 /** @suppress {extraRequire} */
 goog.require('gmf.displayquerygridComponent');
@@ -87,8 +87,8 @@ gmfapp.module.controller('gmfappQueryresultController', gmfapp.QueryresultContro
 /**
  * @constructor
  * @param {gmf.Themes} gmfThemes The gmf themes service.
- * @param {gmf.DataSourcesManager} gmfDataSourcesManager The gmf data sources
- *     manager service.
+ * @param {gmf.datasource.DataSourcesManager} gmfDataSourcesManager The gmf
+ *     data sources manager service.
  * @param {ngeo.FeatureOverlayMgr} ngeoFeatureOverlayMgr The ngeo feature
  *   overlay manager service.
  * @ngInject

contribs/gmf/examples/displayquerywindow.html

@@ -301,7 +301,8 @@
 
     <p id="desc">
       This example shows how to use the <code>ngeo-map-query</code>
-      directive in combination with the <code>gmf.DataSourcesManager</code>.
+      directive in combination with the
+      <code>gmf.datasource.DataSourcesManager</code>.
       The DataSourcesManager fetches the themes returned by the theme
       service and adds one DataSource, which is used by the querent service
       per layer definition found. In this example, the layer tree is

contribs/gmf/examples/displayquerywindow.js

@@ -1,6 +1,6 @@
 goog.provide('gmfapp.displayquerywindow');
 
-goog.require('gmf.DataSourcesManager');
+goog.require('gmf.datasource.DataSourcesManager');
 goog.require('gmf.Themes');
 /** @suppress {extraRequire} */
 goog.require('gmf.displayquerywindowComponent');
@@ -81,8 +81,8 @@ gmfapp.module.controller('AppQueryresultController', gmfapp.QueryresultControlle
 /**
  * @constructor
  * @param {gmf.Themes} gmfThemes The gmf themes service.
- * @param {gmf.DataSourcesManager} gmfDataSourcesManager The gmf data sources
- *     manager service.
+ * @param {gmf.datasource.DataSourcesManager} gmfDataSourcesManager The gmf
+ *     data sources manager service.
  * @param {ngeo.FeatureOverlayMgr} ngeoFeatureOverlayMgr The ngeo feature
  *   overlay manager service.
  * @ngInject

contribs/gmf/examples/filterselector.js

@@ -7,7 +7,7 @@ goog.require('gmf.authenticationDirective');
 goog.require('gmf.Themes');
 goog.require('gmf.TreeManager');
 /** @suppress {extraRequire} */
-goog.require('gmf.DataSourcesManager');
+goog.require('gmf.datasource.DataSourcesManager');
 /** @suppress {extraRequire} */
 goog.require('gmf.filterselectorComponent');
 /** @suppress {extraRequire} */
@@ -53,12 +53,12 @@ gmfapp.MainController = class {
 
   /**
    * @param {!angular.Scope} $scope Angular scope.
-   * @param {gmf.DataSourcesManager} gmfDataSourcesManager The gmf data sources
-   *     manager service.
+   * @param {gmf.datasource.DataSourcesManager} gmfDataSourcesManager The gmf
+   *     data sources manager service.
    * @param {gmf.Themes} gmfThemes The gmf themes service.
    * @param {gmf.TreeManager} gmfTreeManager gmf Tree Manager service.
-   * @param {ngeo.DataSources} ngeoDataSources Ngeo collection of data sources
-   *     objects.
+   * @param {ngeo.datasource.DataSources} ngeoDataSources Ngeo collection of
+   *     data sources objects.
    * @param {ngeo.ToolActivateMgr} ngeoToolActivateMgr Ngeo ToolActivate manager
    *     service.
    * @ngInject

contribs/gmf/options/gmfx.js

@@ -59,24 +59,6 @@ gmfx.ComparisonFilter.prototype.value;
 gmfx.Config;
 
 
-/**
- * The options to create a `gmf.DataSource` with.
- * @record
- * @struct
- * @extends ngeox.DataSourceOptions
- */
-gmfx.DataSourceOptions;
-
-
-/**
- * A reference to the GMF layer node that was used to create the data source.
- * It may contains additionnal information, such as metadata, about the data
- * source.
- * @type {gmfThemes.GmfLayer}
- */
-gmfx.DataSourceOptions.prototype.gmfLayer;
-
-
 /**
  * Configuration for a grid tab.
  * @typedef {{
@@ -564,21 +546,6 @@ gmfx.User.prototype.role_name;
  */
 gmfx.User.prototype.username;
 
-/**
- * @typedef {{
- *  columns : Array.<string>,
- *  data : Array.<Array.<string|number|boolean>>
- * }}
- */
-gmfx.DataSourceTableObject;
-
-/**
- * @typedef {{
- *  title : string,
- *  table : gmfx.DataSourceTableObject
- * }}
- */
-gmfx.DataSourcePrintReportObject;
 
 /**
  * @typedef {{
@@ -656,6 +623,49 @@ gmfx.openIframePopup;
 gmfx.openTextPopup;
 
 
+/**
+ * Namespace.
+ * @type {Object}
+ */
+gmfx.datasource;
+
+
+/**
+ * The options required to create a `gmf.datasource.OGC`.
+ * @record
+ * @struct
+ * @extends ngeox.datasource.OGCOptions
+ */
+gmfx.datasource.OGCOptions;
+
+
+/**
+ * A reference to the GMF layer node that was used to create the data source.
+ * It may contains additionnal information, such as metadata, about the data
+ * source.
+ * @type {gmfThemes.GmfLayer}
+ */
+gmfx.datasource.OGCOptions.prototype.gmfLayer;
+
+
+/**
+ * @typedef {{
+ *  columns : Array.<string>,
+ *  data : Array.<Array.<string|number|boolean>>
+ * }}
+ */
+gmfx.datasource.DataSourceTableObject;
+
+
+/**
+ * @typedef {{
+ *  title : string,
+ *  table : gmfx.datasource.DataSourceTableObject
+ * }}
+ */
+gmfx.datasource.DataSourcePrintReportObject;
+
+
 /**
  * @type {Object}
  */

contribs/gmf/src/controllers/abstract.js

@@ -6,7 +6,7 @@ goog.require('gmf.authenticationDirective');
 /** @suppress {extraRequire} */
 goog.require('gmf.backgroundlayerselectorComponent');
 /** @suppress {extraRequire} */
-goog.require('gmf.DataSourcesManager');
+goog.require('gmf.datasource.DataSourcesManager');
 /** @suppress {extraRequire} */
 goog.require('gmf.TreeManager');
 /** @suppress {extraRequire} */

contribs/gmf/src/datasource/datasourcebeingfiltered.js

@@ -0,0 +1,23 @@
+goog.provide('gmf.datasource.DataSourceBeingFiltered');
+
+goog.require('gmf');
+
+
+gmf.module.value('gmfDataSourceBeingFiltered', {
+  dataSource: null
+});
+
+
+/**
+ * @record
+ * @struct
+ * @export
+ */
+gmf.datasource.DataSourceBeingFiltered = function() {};
+
+
+/**
+ * @type {?gmf.datasource.OGC}
+ * @export
+ */
+gmf.datasource.DataSourceBeingFiltered.prototype.dataSource;

contribs/gmf/src/services/datasourcehelper.js → contribs/gmf/src/datasource/datasourceshelper.js

@@ -1,21 +1,22 @@
-goog.provide('gmf.DataSourcesHelper');
+goog.provide('gmf.datasource.DataSourcesHelper');
 
 goog.require('gmf');
 goog.require('gmf.EnumerateAttribute');
-goog.require('ngeo.DataSourcesHelper');
+goog.require('ngeo.datasource.DataSourcesHelper');
 
 
-gmf.DataSourcesHelper = class {
+gmf.datasource.DataSourcesHelper = class {
 
   /**
-   * A service that provides utility methods to manipulate or get data sources.
+   * A service that provides utility methods to manipulate or get GMF data
+   * sources.
    *
    * @struct
    * @param {angular.$q} $q The Angular $q service.
    * @param {gmf.EnumerateAttribute} gmfEnumerateAttribute The Gmf enumerate
    *     attribute service.
-   * @param {ngeo.DataSourcesHelper} ngeoDataSourcesHelper Ngeo data source
-   *     helper service.
+   * @param {ngeo.datasource.DataSourcesHelper} ngeoDataSourcesHelper Ngeo data
+   *     source helper service.
    * @ngdoc service
    * @ngname gmfDataSourcesHelper
    * @ngInject
@@ -37,7 +38,7 @@ gmf.DataSourcesHelper = class {
     this.gmfEnumerateAttribute_ = gmfEnumerateAttribute;
 
     /**
-     * @type {ngeo.DataSourcesHelper}
+     * @type {ngeo.datasource.DataSourcesHelper}
      * @private
      */
     this.ngeoDataSourcesHelper_ = ngeoDataSourcesHelper;
@@ -46,42 +47,42 @@ gmf.DataSourcesHelper = class {
     // === Other properties ===
 
     /**
-     * @type {gmf.DataSources}
+     * @type {gmf.datasource.DataSources}
      * @protected
      */
     this.collection_;
 
     /**
-     * @type {Object.<number, gmf.DataSource>}
+     * @type {Object.<number, gmf.datasource.OGC>}
      * @protected
      */
     this.cache_;
   }
 
   /**
-   * @return {gmf.DataSources} Data sources collection.
+   * @return {gmf.datasource.DataSources} Data sources collection.
    * @export
    */
   get collection() {
-    return /** @type {gmf.DataSources} */ (
+    return /** @type {gmf.datasource.DataSources} */ (
       this.ngeoDataSourcesHelper_.collection
     );
   }
 
   /**
    * Return a data source using its id.
    * @param {number} id Data source id.
-   * @return {?gmf.DataSource} Data source.
+   * @return {?gmf.datasource.OGC} Data source.
    * @export
    */
   getDataSource(id) {
-    return /** @type {?gmf.DataSource} */ (
+    return /** @type {?gmf.datasource.OGC} */ (
       this.ngeoDataSourcesHelper_.getDataSource(id)
     );
   }
 
   /**
-   * @param {gmf.DataSource} dataSource Filtrable data source.
+   * @param {gmf.datasource.OGC} dataSource Filtrable data source.
    * @return {angular.$q.Promise} Promise.
    * @export
    */
@@ -130,10 +131,10 @@ gmf.DataSourcesHelper = class {
 };
 
 
-gmf.module.service('gmfDataSourcesHelper', gmf.DataSourcesHelper);
+gmf.module.service('gmfDataSourcesHelper', gmf.datasource.DataSourcesHelper);
 
 
 /**
- * @typedef {ol.Collection.<gmf.DataSource>}
+ * @typedef {ol.Collection.<gmf.datasource.OGC>}
  */
-gmf.DataSources;
+gmf.datasource.DataSources;