使用 search 方法可在概要文件存储库查找与搜索条件相匹配的条目。
用途
search SPI 用于搜索概要文件存储库以获取与搜索表达式相匹配的实体。
从搜索返回的属性的列表会包含在输入数据图的 SearchControl 中。此外,PageControl 和/或 SortControl 也可以包含在输入数据图中。输入数据图中的 SearchControl 包括搜索表达式字符串。存储库 API 的实施类需要解析基于 XPath 的搜索表达式字符串。
注: 如果适配器不支持排序,那么将忽略输入数据图中的 SortControl。
如果未使用页面调度功能,该方法将返回包含与搜索表达式相匹配的所有实体的数据图。对于页面调度功能,PageResponseControl 也需要包含在输出数据图中。
如果实体数大于页面大小,必须从 PageResponseControl 返回 cookie,以便其可用于后续调用。如果在页面调度搜索的后续调用中页面大小设置为 0,这意味着调用者不需要其余搜索结果。适配器可以根据需要执行数据清除,例如清除高速缓存。
注: Virtual member manager 不会利用底层数据存储的页面调度功能。
所返回实体的 uniqueName 是 virtual member manager uniqueName,它并非总是与数据存储中的唯一名称相同。适配器根据其配置信息,将数据存储器的唯一名称转换为 virtual member manager uniqueName。
参数
- root
- 指定包含与搜索相关的控件的根数据对象。
返回
包含与搜索表达式相匹配的实体的根数据对象。
签名
DataObject search(DataObject root) 抛出了 WIMException