forked from SuperMap/iClient-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFilterParameter.js
More file actions
139 lines (122 loc) · 6.6 KB
/
FilterParameter.js
File metadata and controls
139 lines (122 loc) · 6.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/* Copyright© 2000 - 2018 SuperMap Software Co.Ltd. All rights reserved.
* This program are made available under the terms of the Apache License, Version 2.0
* which accompanies this distribution and is available at http://www.apache.org/licenses/LICENSE-2.0.html.*/
import {SuperMap} from '../SuperMap';
import {Util} from '../commontypes/Util';
import './JoinItem';
import './LinkItem';
/**
* @class SuperMap.FilterParameter
* @category iServer
* @classdesc 查询过滤条件参数类。该类用于设置查询数据集的查询过滤参数。
* @param {Object} options - 参数。
* @param {string} options.attributeFilter - 属性过滤条件。
* @param {string} options.name - 查询数据集名称或者图层名称。
* @param {Array.<SuperMap.JoinItem>} [options.joinItems] - 与外部表的连接信息 SuperMap.JoinItem 数组。
* @param {Array.<SuperMap.LinkItem>} [options.linkItems] - 与外部表的关联信息 SuperMap.LinkItem 数组。
* @param {Array.<string>} [options.ids] - 查询 id 数组，即属性表中的 SmID 值。
* @param {string} [options.orderBy] - 查询排序的字段，orderBy 的字段须为数值型的。
* @param {string} [options.groupBy] - 查询分组条件的字段。
* @param {Array.<string>} [options.fields] - 查询字段数组。
*/
export class FilterParameter {
constructor(options) {
/**
* @member {string} SuperMap.FilterParameter.prototype.attributeFilter
* @description 属性过滤条件。
* 相当于 SQL 语句中的 WHERE 子句，其格式为：WHERE <条件表达式>，
* attributeFilter 就是其中的“条件表达式”。
* 该字段的用法为 attributeFilter = "过滤条件"。
* 例如，要查询字段 fieldValue 小于100的记录，设置 attributeFilter = "fieldValue < 100"；
* 要查询字段 name 的值为“酒店”的记录，设置 attributeFilter = "name like '%酒店%'"，等等。
*/
this.attributeFilter = null;
/**
* @member {string} SuperMap.FilterParameter.prototype.name
* @description 查询数据集名称或者图层名称，根据实际的查询对象而定。
* 一般情况下该字段为数据集名称，但在进行与地图相关功能的操作时，
* 需要设置为图层名称（图层名称格式：数据集名称@数据源别名）。
* 因为一个地图的图层可能是来自于不同数据源的数据集，
* 而不同的数据源中可能存在同名的数据集，
* 使用数据集名称不能唯一的确定数据集，
* 所以在进行与地图相关功能的操作时，该值需要设置为图层名称。
*/
this.name = null;
/**
* @member {Array.<SuperMap.JoinItem>} [SuperMap.FilterParameter.prototype.joinItems]
* @description 与外部表的连接信息 SuperMap.JoinItem 数组。
*/
this.joinItems = null;
/**
* @member {Array.<SuperMap.LinkItem>} [SuperMap.FilterParameter.prototype.linkItems]
* @description 与外部表的关联信息 LinkItem 数组。
*/
this.linkItems = null;
/**
* @member {Array.<string>} [SuperMap.FilterParameter.prototype.ids]
* @description 查询 id 数组，即属性表中的 SmID 值。
*/
this.ids = null;
/**
* @member {string} [SuperMap.FilterParameter.prototype.orderBy]
* @description 查询排序的字段，orderBy的字段须为数值型的。
* 相当于 SQL 语句中的 ORDER BY 子句，其格式为：ORDER BY <列名>，
* 列名即属性表中每一列的名称，列又可称为属性，在 SuperMap 中又称为字段。
* 对单个字段排序时，该字段的用法为 orderBy = "字段名"；
* 对多个字段排序时，字段之间以英文逗号进行分割，用法为 orderBy = "字段名1, 字段名2"。
* 例如，现有一个国家数据集，它有两个字段分别为“SmArea”和“pop_1994”，
* 分别表示国家的面积和1994年的各国人口数量。
* 如果要按照各国人口数量对记录进行排序，则 orderBy = "pop_1994"；
* 如果要以面积和人口进行排序，则 orderBy = "SmArea, pop_1994"。
*/
this.orderBy = null;
/**
* @member {string} [SuperMap.FilterParameter.prototype.groupBy]
* @description 查询分组条件的字段。
* 相当于 SQL 语句中的 GROUP BY 子句，其格式为：GROUP BY <列名>，
* 列名即属性表中每一列的名称，列又可称为属性，在 SuperMap 中又称为字段。
* 对单个字段分组时，该字段的用法为 groupBy = "字段名"；
* 对多个字段分组时，字段之间以英文逗号进行分割，用法为 groupBy = "字段名1, 字段名2"。
* 例如，现有一个全球城市数据集，该数据集有两个字段分别为“Continent”和“Country”，
* 分别表示某个城市所属的洲和国家。
* 如果要按照国家对全球的城市进行分组， 可以设置 groupBy = "Country"；
* 如果以洲和国家对城市进行分组，设置 groupBy = "Continent, Country"。
*/
this.groupBy = null;
/**
* @member {Array.<string>} [SuperMap.FilterParameter.prototype.fields]
* @description 查询字段数组，如果不设置则使用系统返回的所有字段。
*/
this.fields = null;
if (options) {
Util.extend(this, options);
}
this.CLASS_NAME = "SuperMap.FilterParameter";
}
/**
* @function SuperMap.FilterParameter.prototype.destroy
* @description 释放资源，将引用资源的属性置空。
*/
destroy() {
var me = this;
me.attributeFilter = null;
me.name = null;
if (me.joinItems) {
for (let i = 0, joinItems = me.joinItems, len = joinItems.length; i < len; i++) {
joinItems[i].destroy();
}
me.joinItems = null;
}
if (me.linkItems) {
for (let i = 0, linkItems = me.linkItems, len = linkItems.length; i < len; i++) {
linkItems[i].destroy();
}
me.linkItems = null;
}
me.ids = null;
me.orderBy = null;
me.groupBy = null;
me.fields = null;
}
}
SuperMap.FilterParameter = FilterParameter;