第一步已经为交换建好了 UML 模型(见第 1 部分),接下来要把模型映射到 NIEM,从而确定消息里哪些部分可以复用 NIEM 现成的组件。这个映射过程通常在一份叫「组件映射模板」(CMT)的电子表格里完成。
CMT 之所以有用,主要在于三点:
CMT 一般在 Microsoft Office Excel 或其他电子表格软件(比如 OpenOffice.org Calc)里创建,但用任何表格形式都行。CMT 没有强制格式,不过一份典型的 CMT 至少包含以下几列:
有些实现者会再加几列来记录扩展 NIEM 的细节,本系列第 3 部分会深入探讨扩展 NIEM。
第一步,是在 CMT 的前五列里把 UML 模型抄录下来。第 1 部分给出过一个简单的示例案例:报告一辆已注册车辆失窃。依据那张 UML 类图(再次展示于图 1),表 1 展示了 TheftLocation 类在 CMT 中的样子。为节省篇幅,表 1 省略了说明列,完整的示例 CMT 可从下载部分获取。
图 1. 第 1 部分中的 UML 模型图

查看原图(大图)
表 1. 在 CMT 中表示一个类型和若干属性
| 源类型 | 源属性 | 数据类型 | 说明 | 基数 |
|---|---|---|---|---|
| TheftLocation | ... | TheftLocation | ... | |
| TheftLocation | Address | String | ... | 0..1 |
| TheftLocation | City | String | ... | 0..1 |
| TheftLocation | State | String | ... | 0..1 |
| TheftLocation | ZipCode | String | ... | 0..1 |
| TheftLocation | CountyCode | CountyCode | ... | 0..1 |
数据类型列使用 XML Schema 简单类型名。如果是代码列表,则需要指定一个代码列表名称,有效值记录在电子表格的另一个标签页里。基数以「最小..最大」的形式表示,其中 * 代表无上界。
每个关联都应在 CMT 里占一行,并用另外几行表示该关联涉及的类型引用。表 2 展示了 Theft/TheftLocation 关联的 CMT 写法。
表 2. 在 CMT 中表示一个关联
| 源类型 | 源属性 | 数据类型 | 说明 | 基数 |
|---|---|---|---|---|
| Theft / TheftLocation Assn | ... | Theft / TheftLocation Assn | ... | |
| Theft / TheftLocation Assn | Theft Reference | ... | ... | 1..1 |
| Theft / TheftLocation Assn | TheftLocation Reference | ... | ... | 1..1 |
角色类型则要用一组引用来表示,把角色指向担任该角色的类型。表 3 中的 Witness 角色类型就包含一个指向 Person 的引用,标注为 RoleOfPerson。
表 3. 在 CMT 中表示一个角色
| 源类型 | 源属性 | 数据类型 | 说明 | 基数 |
|---|---|---|---|---|
| Witness | ... | Witness | ... | |
| Witness | Account | String | ... | 0..1 |
| Witness | RoleOfPerson | Reference | ... | 1..1 |
映射的下一个任务是找出你的模型与 NIEM 重叠的部分,并把它们记录到 CMT 里。应尽量复用 NIEM,以最大化与其他 NIEM 应用的互操作性。如果 NIEM 中已存在语义等价的组件,而你的 IEPD 却另造一个,那这个 IEPD 就算不上遵从 NIEM。反过来说,如果数据确实塞不进 NIEM,也不该硬塞——第 3 部分会讲如何为 NIEM 添加扩展组件。
NIEM 模型非常庞大,你肯定不想手工翻架构文件找匹配项。好在有几个在线工具可以帮上忙(链接见参考资料):
用这些工具把 CMT 里可能已存在于 NIEM 的组件逐个找出来。例如在 Schema Central 中搜索 Vehicle,会得到图 2 那样的结果页。
图 2. Schema Central 搜索结果页

查看原图(大图)
点击 nc:Vehicle,会看到图 3 那样的页面:上方是该元素的一般特征,下方是它可能的子元素完整列表。
图 3. Schema Central 元素显示页

查看原图(大图)
所有 NIEM 组件都带有一个命名空间前缀,最基础的 nc 代表 NIEM Core,那里驻留着最根本的类型;每个域也各有前缀(例如 j 表示 Justice)。可以放心使用任何域中的 NIEM 组件,只要它与你的模型语义对等——为了用一个 immigration 域的元素,你并不需要真的去做一个与移民相关的交换。
不论用哪种工具,下面几条都能让搜索轻松不少:
刚开始在 NIEM 里找组件可能令人望而生畏,但随着你对它的常用命名与构造模式日渐熟悉,这个过程会越来越轻松。
找到对等组件后,把它填进 CMT 的 XPath 列。一般使用简单的 XPath 表达式即可——元素和/或属性名以斜杠(/)分隔,类型名不必写入。务必带上命名空间前缀(如 nc:),因为元素名在不同命名空间之间并不保证唯一。
表 4 展示了 TheftLocation 的 XPath 映射。注意:为排版美观,较长的 XPath 被拆成了多行,实际填写时通常是单个字符串。
表 4. TheftLocation 的 XPath 映射
| 源类型 | 源属性 | ... | Ext? | XPath |
|---|---|---|---|---|
| TheftLocation | ... | ... | nc:Location | |
| TheftLocation | Address | ... | N | nc:Location/nc:LocationAddress/nc:StructuredAddress/nc:LocationStreet/nc:StreetFullText |
| TheftLocation | City | ... | N | nc:Location/nc:LocationAddress/nc:StructuredAddress/nc:LocationCityName |
| TheftLocation | State | ... | N | nc:Location/nc:LocationAddress/nc:StructuredAddress/nc:LocationState USPostalServiceCode |
| TheftLocation | Zip | ... | N | nc:Location/nc:LocationAddress/nc:StructuredAddress/nc:LocationPostalCode |
| TheftLocation | CountyCode | ... | Y |
XPath 应包含足够多的步骤,以便唯一标识目标。例如不要只写 nc:StreetFullText 来表示 Address。有时会有多条路径通向 NIEM 中的同一个元素,为了精确,需要写出完整路径。
本例中,CountyCode(一个州内专用的区县代码)在 NIEM 中并不存在,因此需要一个扩展:Ext? 列标为 Y,XPath 暂时留空。第 3 部分将详细说明为扩展填写 XPath 的过程。要看完整的映射,请参考下载部分提供的电子表格。
确定好要复用哪些 NIEM 组件之后,就可以创建 NIEM 模型的子集了——形式是一组 XML Schema 文档。
为什么需要子集?因为完整的 NIEM 模型既庞大、约束又相对宽松。子集能更精确地校验你的交换:它限定哪些元素和属性可以出现、各可出现多少次,某些情况下还限定允许的取值。此外,子集架构小得多,XML 消息的校验速度也会明显加快。
我们用 NIEM SSGT 来生成子集。图 4 是 SSGT 的初始页面,包含两个窗格:右侧用于搜索和导航 NIEM 模型,左侧则实时显示你已加入的子集。
图 4. SSGT 主页面

查看原图(大图)
照着 CMT 做几轮搜索,找到组件并加入子集。SSGT 允许按属性(元素或属性名)、类型、关联或其他组件来搜索。由于 CMT 里记的是元素名,按属性搜索通常更有效率。示例搜索结果如图 5 所示。
你可能会问:既然 SSGT 一个工具就能同时完成映射和建子集,为什么还要拆成两步?确实可以同时做,但许多 NIEM 实践者发现,用 NIEM Wayfarer 或 Schema Central 做映射更轻松——它们能更清晰地展示实际(扁平)的类型结构。而用 SSGT 导航需要更多 NIEM 知识(以及更多鼠标点击)。因此,先备好一份准确列出所需组件的 CMT,再用 SSGT 建子集,整体效率更高。
图 5. SSGT 搜索结果页

查看原图(大图)
找到目标 NIEM 组件后,点击 Add 即可加入子集,它会出现在左侧窗格的 NIEM Schema Subset 之下(图 6)。
添加属性时,其类型会被自动一并加入。例如添加 nc:PersonName,nc:PersonNameType 也会自动出现在子集中。显式选择的组件在左窗格中以粗体显示并带复选框,附带的组件则不用粗体。
图 6. SSGT 子集

查看原图(大图)
需要注意的是,SSGT 默认不会自动添加某个类型的子属性。比如加了 nc:PersonName,它并不包含 nc:PersonGivenName 和 nc:PersonSurName,这两个得分别添加。而且添加时必须处在 nc:PersonName 的上下文里,父子关系才能保住。做法是:在搜索结果中展开 nc:PersonName 这棵树,然后点击 nc:PersonGivenName 旁边的 Add(图 7)。
图 7. 使用 SSGT 添加子元素

查看原图(大图)
反过来,如果你单独搜索 PersonGivenName 再从结果里添加,元素虽然会被加入,但它不会成为 nc:PersonName 的子元素。
图 7 还展示了另一个细节:添加类型属性时可以指定基数。点击 Add 按钮上的向下箭头会弹出下拉菜单,列出可选基数,默认值是 0 到无穷大。
如果某个属性是通过继承得来的,它在 SSGT 层次里默认不显示。例如在搜索结果中展开 nc:Vehicle,并不会自动列出映射到 Property Description 的 nc:ItemDescriptionText。要看到这些继承属性,请点击(nc:VehicleType 旁边的)show inheritance,再展开真正包含相关属性的类型——本例中是 nc:ItemType(图 8)。
图 8. 使用 SSGT 添加继承属性

查看原图(大图)
NIEM 大量使用 XML Schema 的抽象元素与替换组。举个例子,表示货物颜色就有好几种方式:NIEM 定义了一个抽象元素 nc:ItemColor,它本身不能出现在任何 XML 实例中,必须被替换成 nc:VehicleColorPrimaryCode 或 nc:ItemColorDescriptionText 之类的具体元素。用 XML Schema 的术语说,后两者是同一个替换组的成员,而 nc:ItemColor 是它们的上級(head)。
抽象元素让建子集这件事复杂了一层:你必须把可替换的具体元素加进子集,而不只是那个抽象元素。SSGT 用 abstract 一词标记所有抽象元素,并允许你展开它们查看可替换项(图 9)。
图 9. 使用 SSGT 添加可替换元素

查看原图(大图)
大多数日期相关类型也含一个抽象元素 nc:DateRepresentation,可由 nc:Date、nc:DateTime 等替换。一个常见错误是:直接添加 nc:ActivityDate 这样的日期属性就完事,而没有展开它、点击 nc:DateRepresentation、再选 nc:Date 来使用恰当的子元素。
子集建好后,可以直接在 SSGT 左侧窗格里调整:勾选组件旁的复选框再点 Delete 即可删除;展开相应的简单类型,还能删掉允许使用的代码列表值(默认情况下,一个简单类型的所有代码列表值都会被纳入子集)。此外,点击左窗格顶部的 Edit Cardinality 可以重新设定基数,再给「父类型中某个属性允许出现几次」一次修正机会。
此时子集不必完美。NIEM 子集的创建通常是个反复迭代的过程,直到 IEPD 开发的最后阶段,你仍可随时修改并保存。
点击页面右上角的 Generate Documents,会弹出一个类似图 10 的窗口,其中列出了若干生成选项。选择 Save Subset Schema to a file,再指定保存位置即可。
图 10. 使用 SSGT 生成子集

查看原图(大图)
这一步会生成一个名为 Subset.zip 的压缩包,其中 niem 子文件夹里放着 NIEM 子集。此外,它还会为你所选的每个命名空间各生成一份架构文档,外加若干所有子集都会附带的通用架构。
只有被选择的类型会写进架构文档,而这些类型也只包含被选中的属性。例如,尽管 nc:PersonNameType 在整个 NIEM 模型中有 7 个可能的子元素、且基数都是 0..*,你的子集架构里却只会出现清单 1 的内容。
清单 1. NIEM 子集中的 nc:PersonNameType
<xsd:complexType name="PersonNameType">
<xsd:complexContent>
<xsd:extension base="s:ComplexObjectType">
<xsd:sequence>
<xsd:element ref="nc:PersonGivenName" minOccurs="0" maxOccurs="1"/>
<xsd:element ref="nc:PersonSurName" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
这个子集里还有一份名为 wantlist.xml 的 XML 文档,列出所有已加入子树的元素及其基数。日后若要调整,这个 wantlist 就派上了用场:把它重新上传到 SSGT,修改后再重新生成即可。清单 2 是其中一段。
清单 2. 部分 NIEM 子集 wantlist
<w:WantList w:release="2.1" w:product="NIEM" ...>
<w:Element w:name="j:Person" w:isReference="false"/>
<w:Element w:name="j:Witness" w:isReference="false"/>
...
<w:Type w:name="j:PersonType" w:isRequested="false">
<w:ElementInType w:minOccurs="0" w:maxOccurs="1"
w:name="j:PersonAugmentation" w:isReference="false"/>
</w:Type>
<w:Type w:name="j:WitnessType" w:isRequested="false">
<w:ElementInType w:minOccurs="0" w:maxOccurs="1"
w:name="j:WitnessAccountDescriptionText" w:isReference="false"/>
<w:ElementInType w:minOccurs="1" w:maxOccurs="1"
w:name="nc:RoleOfPerson" w:isReference="true"/>
</w:Type>
...
</w:WantList>
本文演示了如何用 CMT 把 UML 交换模型映射到 NIEM,并接着说明了用 NIEM SSGT 创建子集的全过程。在第 3 部分里,我们将处理 CMT 中那些还空着的行——扩展:介绍扩展 NIEM 的几种不同思路,并带你一步步创建 Exchange 架构与 Extension 架构。