集合函数

描述

某些函数（通常是用于导航聚合结构树的函数）返回元素集，用户可以使用特定的函数和运算符对这些元素集进行操作。

And 函数

元素	描述
可用性	从 3.0903 起
语法	* 或 &
返回值	集合之间的交集

示例

$Category.getNode("01").lowest * $Category.getNode("02").lowest

返回由同时与类别组的节点 "01" 和 "02" 相关的最低层级元素组成的集合。

Or 函数

元素	描述
可用性	从 3.0903 起
语法	+ 或 /
返回值	集合之间的并集。重复项会被删除。

示例

$Entity.allAncestors(2) + $Entity.children

返回由当前节点的父节点、祖父节点和子节点组成的集合。

Complement 函数

元素	描述
可用性	从 3.0903 起
语法	-
返回值	集合之间的差集（补集）

示例

$Entity.allDescendants(5) - $Entity.children

返回直到第五层级的所有后代，不包括应用该函数的实体节点的子节点。

Contains 函数

元素	描述
可用性	从 3.0903 起
语法	contains(element)
参数	element：要在集合中搜索的元素，定义为引号之间的字符串或维度函数
返回值	如果 element 参数属于该集合，则返回 1，否则返回 0。

示例

Entity.lowest.contains($Entity.getLeaf("A01"))

如果实体节点的后代包含实体 "A01"，则返回 1，否则返回 0。

Item 函数

元素	描述
可用性	从 3.0903 起
语法	item(index)
参数	index：标识属于该集合的元素的索引
返回值	索引作为参数指定的集合元素（从 0 开始）。如果集合的子元素数量少于指示的索引+1，则返回错误。

示例

$Entity.children.item(0)：返回实体节点的第一个子节点。

$Entity.children.item(1)：返回实体节点的第二个子节点。

Err() 函数

元素	描述
可用性	从 4.3.1 起
语法	err()
返回值	始终返回错误。

Iserror 函数

元素	描述
可用性	从 4.3.1 起
语法	iserror(argument)
参数	argument：通用函数
返回值	如果处理的参数是错误，则返回 TRUE，否则返回 FALSE。

Set 函数

元素	描述
可用性	从 3.0903 起
语法	set(element1, element2, ...elementN)
参数	elemento1 elemento2 element<...>：将组成集合的元素，定义为引号之间的字符串或维度函数
返回值	创建一个以处理的参数作为元素的集合。 注意：如果其中一个参数是错误，系统将返回一个仅包含不返回错误的元素的集合。

示例

Set($Entity.getNode("C1"), $Entity.getNode("C2"))

包含过滤器中指定的实体层次的节点 C1 和 C2 的集合。

Size 函数

元素	描述
可用性	从 3.0903 起
语法	size
返回值	集合中的元素数量

示例

$Entity.children.size

返回过滤器中指定的实体层次节点中的工作表数量。

Sum/Intersect 函数

元素	描述
可用性	从 3.0903 起
语法	sum(set1, set2, ... set<...>), intersect(set1, set2, ... setN)
参数	set <...>：要与后续参数中指定的集合进行并集或交集运算的对象集合。
返回值	作为参数指示的集合之间的并集和交集

示例

考虑两个变量 a 和 b，定义如下：

a := Set($Entity.getNode("C1"), $Entity.getNode("C2"));

b := Set($Entity.getNode("C3"), $Entity.getNode("C4"));

sum(a, b)

返回一个包含过滤器中指定的实体层次的节点 C1、C2、C3 和 C4 的集合。

TrimSet 函数

元素	描述
可用性	从 3.0903 起
语法	trimSet(numElements)
参数	numElements：从第一个元素开始要考虑的元素数量。
返回值	集合的前 "numElements" 个元素。如果集合包含的元素较少，则全部返回。

示例

$Entity.lowest.trimSet(3)

返回属于指定实体所属的实体层次节点子树的前三个实体。