【feature】GetFeaturesByGeometryParameters增加orderBy参数支持排序

songyumeng · songyumeng · commit dc95b33d5b53 · 2024-08-20T17:32:57.000+08:00
diff --git a/src/common/iServer/FilterParameter.js b/src/common/iServer/FilterParameter.js
@@ -67,14 +67,14 @@ export class FilterParameter {
         /**
          * @member {string} [FilterParameter.prototype.orderBy]
          * @description 查询排序的字段，orderBy 的字段须为数值型的。
-         * 相当于 SQL 语句中的 ORDER BY 子句，其格式为：ORDER BY <列名>，
+         * 相当于 SQL 语句中的 ORDER BY 子句，其格式为：ORDER BY <列名>或ORDER BY <列名 排序规则>。
          * 列名即属性表中每一列的名称，列又可称为属性，在 SuperMap 中又称为字段。
-         * 对单个字段排序时，该字段的用法为 orderBy = "字段名"；
-         * 对多个字段排序时，字段之间以英文逗号进行分割，用法为 orderBy = "字段名1, 字段名2"。
-         * 例如，现有一个国家数据集，它有两个字段分别为“SmArea”和“pop_1994”，
-         * 分别表示国家的面积和 1994 年的各国人口数量。
-         * 如果要按照各国人口数量对记录进行排序，则 orderBy = "pop_1994"；
-         * 如果要以面积和人口进行排序，则 orderBy = "SmArea, pop_1994"。
+         * 排序规则即按字段的升序或降序排序，asc 表示升序，desc 表示降序，不指定排序规则按升序排序。
+         * 对单个字段排序时，该字段的用法为 orderBy = "字段名"，升序为orderBy = "字段名 asc"；降序为 orderBy = "字段名 desc"； 
+         * 对多个字段排序时，字段之间以英文逗号进行分割，用法为 orderBy = "字段名1, 字段名2 asc, 字段名2 desc"。
+         * 例如，在一个国家数据集中，有两个字段，字段名分别为“SmArea”和“pop_1994”，分别表示国家的面积和1994年的各国的人口数量，
+         * 如果要按照各国人口数量对记录进行排序，可以设置 orderBy = "pop_1994"；
+         * 如果要以面积降序和人口升序进行排序， 设置 orderBy = "SmArea desc, pop_1994 asc"。
          */
         this.orderBy = null;
 
diff --git a/src/common/iServer/GetFeaturesByGeometryParameters.js b/src/common/iServer/GetFeaturesByGeometryParameters.js
@@ -21,6 +21,7 @@ import { ServerGeometry } from './ServerGeometry';
  * @param {Array.<string>} options.datasetNames - 数据集集合中的数据集名称列表。
  * @param {string} [options.attributeFilter] - 几何查询属性过滤条件。
  * @param {Array.<string>} [options.fields] - 查询结果返回字段。默认返回所有字段。
+ * @param {string} [options.orderBy] - 查询排序的字段，orderBy 的字段须为数值型的。
  * @param {SpatialQueryMode} [options.spatialQueryMode=SpatialQueryMode.CONTAIN] - 空间查询模式。
  * @param {boolean} [options.returnContent=true] - 是否直接返回查询结果。
  * @param {boolean} [options.returnFeaturesOnly=false] - 是否仅返回要素信息。当 returnContent 为 true 时设置有效。
@@ -67,6 +68,20 @@ export class GetFeaturesByGeometryParameters extends GetFeaturesParametersBase {
          * @description 空间查询模式。
          */
         this.spatialQueryMode = SpatialQueryMode.CONTAIN;
+
+        /**
+         * @member {string} [GetFeaturesByGeometryParameters.prototype.orderBy]
+         * @description 查询排序的字段，orderBy 的字段须为数值型的。
+         * 相当于 SQL 语句中的 ORDER BY 子句，其格式为：ORDER BY <列名>或ORDER BY <列名 排序规则>。
+         * 列名即属性表中每一列的名称，列又可称为属性，在 SuperMap 中又称为字段。
+         * 排序规则即按字段的升序或降序排序，asc 表示升序，desc 表示降序，不指定排序规则按升序排序。
+         * 对单个字段排序时，该字段的用法为 orderBy = "字段名"，升序为orderBy = "字段名 asc"；降序为 orderBy = "字段名 desc"； 
+         * 对多个字段排序时，字段之间以英文逗号进行分割，用法为 orderBy = "字段名1, 字段名2 asc, 字段名2 desc"。
+         * 例如，在一个国家数据集中，有两个字段，字段名分别为“SmArea”和“pop_1994”，分别表示国家的面积和1994年的各国的人口数量，
+         * 如果要按照各国人口数量对记录进行排序，可以设置 orderBy = "pop_1994"；
+         * 如果要以面积降序和人口升序进行排序， 设置 orderBy = "SmArea desc, pop_1994 asc"。
+         */
+        this.orderBy = null;
         Util.extend(this, options);
 
         this.CLASS_NAME = 'SuperMap.GetFeaturesByGeometryParameters';
@@ -92,6 +107,7 @@ export class GetFeaturesByGeometryParameters extends GetFeaturesParametersBase {
         me.attributeFilter = null;
         me.spatialQueryMode = null;
         me.getFeatureMode = null;
+        me.orderBy = null;
     }
 
     /**
@@ -110,10 +126,15 @@ export class GetFeaturesByGeometryParameters extends GetFeaturesParametersBase {
             geometry: geometry,
             spatialQueryMode: params.spatialQueryMode
         };
-        if (params.fields) {
+        if (params.fields || params.orderBy) {
             filterParameter = new FilterParameter();
             filterParameter.name = params.datasetNames;
-            filterParameter.fields = params.fields;
+            if (params.fields) {
+                filterParameter.fields = params.fields;
+            }
+            if (params.orderBy) {
+                filterParameter.orderBy = params.orderBy;
+            }
             parasByGeometry.queryParameter = filterParameter;
         }
         if (params.attributeFilter) {
@@ -138,7 +159,6 @@ export class GetFeaturesByGeometryParameters extends GetFeaturesParametersBase {
         if (params.aggregations) {
             parasByGeometry.aggregations = params.aggregations;
         }
-
         return Util.toJSON(parasByGeometry);
     }
 }
diff --git a/test/common/iServer/GetFeaturesByGeometryServiceSpec.js b/test/common/iServer/GetFeaturesByGeometryServiceSpec.js
@@ -380,4 +380,34 @@ describe('GetFeaturesByGeometryService', () => {
     });
     getFeaturesByGeometryService.processAsync(getFeaturesByGeometryParameters, serviceCompleted);
   })
+  it('GetFeaturesByGeometryParameters:orderBy', done => {
+    var serviceCompleted = serviceSucceedEventArgsSystem => {
+      console.log('serviceSucceedEventArgsSystem', serviceSucceedEventArgsSystem);
+      try {
+        getFeaturesByGeometryService.destroy();
+        getFeaturesByGeometryParameters.destroy();
+        expect(serviceSucceedEventArgsSystem.result).not.toBeNull();
+        done();
+      } catch (exception) {
+        expect(false).toBeTruthy();
+        console.log('GetFeaturesByGeometryService_' + exception.name + ':' + exception.message);
+        getFeaturesByGeometryService.destroy();
+        getFeaturesByGeometryParameters.destroy();
+        done();
+      }
+    };
+    var getFeaturesByGeometryService = new GetFeaturesByGeometryService(dataServiceURL);
+    var point = new Point(112, 36);
+    var getFeaturesByGeometryParameters = new GetFeaturesByGeometryParameters({
+      datasetNames: ['World:Countries'],
+      geometry: point,
+      orderBy: "SMID"
+    });
+    spyOn(FetchRequest, 'commit').and.callFake((method, testUrl, params, options) => {
+      var paramsObj = JSON.parse(params.replace(/'/g, '"'));
+      expect(paramsObj.queryParameter.orderBy).toBe("SMID");
+      return Promise.resolve(new Response(JSON.stringify(getReturnFeaturesOnlyResultJson)));
+    });
+    getFeaturesByGeometryService.processAsync(getFeaturesByGeometryParameters, serviceCompleted);
+  })
 });
