QueryParameter类参考

查询参数类。 更多...

被ServiceQueryParameter继承.

所有成员的列表。

公有成员
(id)	- init
	构造一个新的 QueryParameter 对象。
(id)	- init:
	根据给定的 QueryParameter 对象构造一个与其完全相同的新对象。
(void)	- dispose
	释放该对象所占用的资源。调用该方法之后，此对象不再可用。
(NSString *)	- toJson
	将查询参数转换成Json串。
静态公有成员
(NSString *)	+ dateToDouble:month:day:hours:minutes:seconds:
属性
CursorType	cursorType
	获取或设置查询所采用的游标类型。SuperMap 支持两种类型的游标，分别为动态游标和静态游标。使用动态游标查询时，记录集会动态的刷新，耗费很多的资源，而当使用静态游标时，查询的为记录集的静态副本，效率较高。推荐在查询时使用静态游标，使用静态游标获得的记录集是不可编辑的。详细信息请参见 CursorType 类型。
NSString *	attriButeFilter
	获取或设置查询所构建的 SQL 条件语句，即 SQL WHERE CLAUSE 语句。SQL 查询又称为属性查询，是通过一个或多个 SQL 条件语句来查询记录。SQL 语句是包含属性字段、运算符号和数值的条件语句。例如，你希望查询一个商业区内去年的年销售额超过30万的服装店，则构建的 SQL 查询语句为：Sales > 30,0000 AND SellingType = ‘Garment’。
BOOL	hasGeometry
	获取或设置查询结果是否包含几何对象字段。
NSArray *	orderBy
	获取或设置SQL查询排序的字段。对于 SQL 查询得到的记录集中的各记录，可以根据指定的字段进行排序，并可以指定为升序排列或是降序排列。注意用于排序的字段必须为数值型。
NSArray *	groupBy
	获取或设置SQL 查询分组条件的字段。对于 SQL 查询得到的记录集中的各字段，可以根据指定的字段进行分组，指定的字段值相同的记录将被放置在一起。
NSArray *	queryIDs
	获取或设置id查询的id数组。
Rectangle2D *	queryBounds
	获取或设置bounds查询的范围。
QueryType	queryType
	获取或设置查询类型。
NSArray *	resultFields
	获取或设置查询结果字段集合。对于查询结果的记录集中，可以设置其中所包含的字段，如果为空，则查询所有字段。
SpatialQueryMode	spatialQueryMode
	获取或设置空间查询操作模式。
id	spatialQueryObject
	获取或设置空间查询中的搜索对象。可以是 <Point2D> ， <Rectangle2D> ， <GeoPoint geopoint>=""> ， <GeoLine> ， <GeoRegion> ， <DatasetVector> ， <Recordset> 等类型的对象。

---

详细描述

查询参数类。

用于描述一个条件查询的限制条件，如所包含的 SQL 语句，游标方式等。

条件查询，是查询满足一定条件的所有要素的记录，其查询得到的结果是记录集。查询参数类是用来设置条件查询的查询条件从而得到记录集。SQL 查询，又称属性查询，即通过构建包含属性字段、运算符号和数值的 SQL 条件语句来选择记录，从而得到记录集。

该类中 attriButeFilter ， orderBy 以及 groupBy 是用来返回和设置属性查询的相关信息的； spatialQueryObject 和 spatialQueryMode 用来返回和设置空间查询的相关信息。

---

成员函数文档

+ (NSString*) dateToDouble:		(int)	year
month:		(int)	month
day:		(int)	day
hours:		(int)	hours
minutes:		(int)	minutes
seconds:		(int)	seconds

- (void) dispose

释放该对象所占用的资源。调用该方法之后，此对象不再可用。

- (id) init

构造一个新的 QueryParameter 对象。

- (id) init:

(QueryParameter *)

queryParameter

根据给定的 QueryParameter 对象构造一个与其完全相同的新对象。

参数:

queryParameter

指定的 QueryParameter 对象。

- (NSString *) toJson

将查询参数转换成Json串。

返回:

查询参数转换的Json串。

在ServiceQueryParameter内被实现。

---

属性文档

- (NSString*) attriButeFilter [read, write, retain]

获取或设置查询所构建的 SQL 条件语句，即 SQL WHERE CLAUSE 语句。SQL 查询又称为属性查询，是通过一个或多个 SQL 条件语句来查询记录。SQL 语句是包含属性字段、运算符号和数值的条件语句。例如，你希望查询一个商业区内去年的年销售额超过30万的服装店，则构建的 SQL 查询语句为：Sales > 30,0000 AND SellingType = ‘Garment’。

默认值为一个空字符串。

返回:

查询所构建的 SQL 条件语句，即 SQL WHERE CLAUSE 语句。

- (CursorType) cursorType [read, write, assign]

获取或设置查询所采用的游标类型。SuperMap 支持两种类型的游标，分别为动态游标和静态游标。使用动态游标查询时，记录集会动态的刷新，耗费很多的资源，而当使用静态游标时，查询的为记录集的静态副本，效率较高。推荐在查询时使用静态游标，使用静态游标获得的记录集是不可编辑的。详细信息请参见 CursorType 类型。

默认值为 DYNAMIC DYNAMIC 类型。

返回:

查询所采用的游标类型。

参见:

CursorType

- (NSArray*) groupBy [read, write, retain]

获取或设置SQL 查询分组条件的字段。对于 SQL 查询得到的记录集中的各字段，可以根据指定的字段进行分组，指定的字段值相同的记录将被放置在一起。

默认值为个数为0的字符串数组。

返回:

SQL 查询分组条件的字段。

- (BOOL) hasGeometry [read, write, assign]

获取或设置查询结果是否包含几何对象字段。

默认值为 true。

返回:

查询结果包含几何对象字段，返回 true，不包含几何对象字段返回 false。

- (NSArray*) orderBy [read, write, retain]

获取或设置SQL查询排序的字段。对于 SQL 查询得到的记录集中的各记录，可以根据指定的字段进行排序，并可以指定为升序排列或是降序排列。注意用于排序的字段必须为数值型。

默认值为个数为0的字符串数组。

返回:

SQL 查询排序的字段。

- (Rectangle2D*) queryBounds [read, write, retain]

获取或设置bounds查询的范围。

返回:

bounds查询的范围。

- (NSArray*) queryIDs [read, write, retain]

获取或设置id查询的id数组。

返回:

id查询的id数组。

- (QueryType) queryType [read, write, assign]

获取或设置查询类型。

返回:

查询类型。

- (NSArray*) resultFields [read, write, retain]

获取或设置查询结果字段集合。对于查询结果的记录集中，可以设置其中所包含的字段，如果为空，则查询所有字段。

默认值为个数为0的字符串数组。

返回:

查询结果字段集合。

- (SpatialQueryMode) spatialQueryMode [read, write, assign]

获取或设置空间查询操作模式。

默认值为NONE 模式。

返回:

空间查询操作模式。

- (id) spatialQueryObject [read, write, assign]

获取或设置空间查询中的搜索对象。可以是 <Point2D> ， <Rectangle2D> ， <GeoPoint geopoint>=""> ， <GeoLine> ， <GeoRegion> ， <DatasetVector> ， <Recordset> 等类型的对象。

若搜索对象是数据集或是记录集类型，则必须同被搜索图层对应的数据集的地理坐标系一致。

默认值为 null。

返回:

空间查询中的搜索对象。

---

该类的文档由以下文件生成：

• QueryParameter.h