API函数使用手册v11.docx

1、API函数使用手册v11新一代信息系统建设浦发银行架构建模管理工具平台建设项目数据建模工具及实施服务API函数使用手册V1.1文档编排规范及约定【文档编排规范及约定】的内容仅是对本文档编写的规范和约定进行描述，文档编写人员须严格按照本规范和约定进行编写，在文档正式发布时删除该部分内容；须填写“文档修订控制记录”；文档目录须更新为最新的，与实际内容相对应；序号修订内容修订日期版本号修订人审核人1创建2014-11-040.1曹凯华2完善了API帮助文档的介绍2014-11-290.2曹凯华3编写PowerDesigner脚本开发示例2014-11-300.3曹凯华4清稿2015-01-161.0

2、曹凯华5补充脚本开发示例的简介2015-01-301.1曹凯华目录1. 前言 41.1. 编写目的 41.2. 适用范围 41.3. 预期读者 42. PowerDesigner API简介 52.1. 概述 52.2. 查询API帮助文档 52.3. 常用API简介 153. PowerDesigner脚本开发示例 433.1. 概述 433.2. 创建和打开模型 433.3. 浏览和修改模型的集合 443.4. 操纵知识库 453.5. PDM模型的正向工程 453.6. PDM模型的反向工程 481. 前言1.1. 编写目的为了指导开发人员初步掌握Sybase PowerDesigner

3、 API帮助文档的查询方法、了解Sybase PowerDesigner脚本程序的开发步骤，特编写此手册。本手册分为两部分，第一部分介绍了API帮助文档的目录结构和常用的API类库；第二部分并针对一些常用的使用场景，给出了API函数的使用示例。1.2. 适用范围本手册叙述的产品特性、操作命令、用户界面均基于下列版本的产品 Window 2008 Enterprise SP2 SQL Server 2008 R21.3. 预期读者Sybase PowerDesigner脚本开发人员2. PowerDesigner API简介2.1. 概述PowerDesigner客户端提供了丰富的API及详尽的

4、说明文档，开发人员通过编写VBS脚本、调用API，可以执行大批量、重复性的模型管理和维护任务。2.2. 查询API帮助文档2.2.1. 打开方法用户可以通过点击PowerDesigner客户端的 Help - Metamodel Objects Help 菜单项，打开PowerDesigner API帮助文档。如下图：2.2.2. 目录结构说明PowerDesigner API帮助文档采用CHM文件格式，文档的目录树将文档分成三部分：1) Basic Elements 基础元素这部分包含PowerDesigner自定义的集合类型（Collections）、结构体类型（Structured Ty

5、pes）、全局属性（Global Properties）、全局常数（Global Constans）以及全局函数（Global Functions）。2) Libraries 类库在Libraries目录下，每个文件夹代表一个类库，类库包含了所有相关类的API文档。其中，普通类的API文档直接位于类库文件夹下；抽象类的API文档在类库文件夹下的Abstract Classes文件夹下。下图展示了Libraries目录及其下PdWSP类库的完整结构。类库从功能上分为两大类：公共类库和模型类库。类别类库说明公共类库PdCommon通用类库，包含了模型或组件的基类，以及模型比较、模型检查等通用功能类

6、PdWSP对应于PowerDesigner客户端的工作空间组件PdRMG对应于PowerDesigner客户端的知识库组件模型类库PdXXX模型对应的类库名以“Pd”+ 模型的缩写组成，包含了该模型类及模型子元素类PdGLM对应于Glossary模型PdLDM对应于LDM模型PdPDM对应于PDM模型类库包含了所有相关类的API文档。其中，普通类的API文档直接位于类库文件夹下；抽象类的API文档在类库文件夹下的Abstract Classes文件夹下。下图展示了Libraries目录及其下PdWSP类库的完整结构。3) Appendix 附录附录包含三部分内容： Classes Hierar

7、chy（所有类的层次结构） Code sample（代码示例） Classes IDs（所有类的类型标识列表）2.2.3. API文档说明2.2.3.1. 总体结构每个类的API文档都包含以下几部分内容： Class Name（类名称） Classes Hierarchy（类层次结构） Description（类描述信息） Specific Members（特有成员列表） Full Definition（全部成员接口）下面以PdPDM类库下的抽象类BaseTable为例，说明各部分的含义。2.2.3.2. 详细说明2.2.3.2.1. Class Name（类名称）在API文档页首，会以蓝色背

8、景红色粗体字“类的类型名称: 类的显示名称”的形式标示类名称信息，如果是抽象类，名称之后还会有“(abstract)”字样的提示，如下图：其中，类的显示名称是类的ClassName属性的值；类的类型名称是类的ObjectType属性的值，“cls_”前缀加上类型名称构成了类型标识常数，如BaseTable类的类型常数是cls_BaseTable。 判断一个对象是否是某类的方法使用对象的ClassKind属性与类型标识常数作比较，如果相等，则该对象的类就是类型标识常数所代表的类。例如：通过以下语句可以判断对象Obj是否是BaseTable类。If Obj.ClassKind = cls_Base

9、Table thenOutput “是BaseTable类型”ElseOutput “不是BaseTable类型”End If2.2.3.2.2. Classes Hierarchy（类层次结构）在类名称下方，有一个类层次结构树，如下图：类层次结构树描述了从基类到当前类之间的所有层次结构。如果有子类继承，可以通过点击继承树右侧的“.”按钮来显示和隐藏子类的层次结构。API中的所有类都继承于BaseObject类，且所有类的层次结构都遵循于“BaseObject类PdCommon类库类类库抽象类类库类”规则。2.2.3.2.3. Description（类描述信息）Description部分描述

10、了类所对应的PowerDesigner对象，有些还会包含类的使用示例。在描述信息的最后会有一个该类所对应的PowerDesigner对象的图标。2.2.3.2.4. Specific Members（特有成员列表）对应大多数类，很多成员都是从父类继承而来。Specific Members部分则列出了当前类所特有的成员的列表，包括属性、集合和方法。开发人员可以着重关注这些类特有成员，以了解该类有哪些特殊功能。2.2.3.2.5. Full Definition（全部成员接口）2.2.3.2.5.1. 成员接口的显示顺序API文档的Full Definition部分包含了当前类的所有成员的接口说明

11、，这些成员分为属性（Properties）、集合（Collections）和方法（Methods）三部分，每部分又按照类的层次结构依次罗列。以PdPDM类库的抽象类BaseTable类为例，其层次结构如下：在Full Definition部分，先依次罗列了继承于BaseObject类、IdentifiedObject类、ExtensibleObject类、NamedObject类、NamedClassifier类的属性在罗列完所有继承于父类的属性之后，再列出BaseTable类特有的属性可以发现，由于BaseObject类是所有类的基类，所以每一个类都包含“Parent”、“ClassName

12、”、“ObjectType”、“ClassKind”等BaseObject类的属性。相应地，其他父类的属性也会被继承下来。一般来说，要了解某个类所的功能，除了阅读类的描述信息（Description）与类的层次结构，还应重点关注类的特有成员，即Specific Members中所列出的属性、集合和方法。2.2.3.2.5.2. Properties（属性列表）属性列表按照类的继承顺序，依次罗列了从父类继承的属性，以及当前类所特有的属性。列表包含两列，第一列以“属性名称 As 类型”的形式描述了属性的定义（Properties）；第二列描述了属性的使用方法（Usage）。2.2.3.2.5.3.

13、 Collections（集合列表）集合列表按照类的继承顺序，罗列了从父类继承的集合，以及当前类所特有的集合。列表包含两列，第一列以“集合名称 As 类型”的形式描述了集合的定义（Collections）；第二列描述了集合的使用方法（Usage），使用方法中说明了该集合中包含元素的类型，并给出类型所在类的链接。2.2.3.2.5.4. Methods（方法列表）方法列表按照类的继承顺序，罗列了从父类继承的方法，以及当前类所特有的方法。每个方法都包含方法定义，以及参数用法的说明。方法的定义格式如下：方法名 ( ByVal|ByRef 参数1 As 类型 = 默认值 , ByVal|ByRef 参

14、数2 As 类型 = 默认值, ) As类型其中， 使用ByVal申明的参数是输入参数 使用ByRef申明的参数是输出参数 带有默认值的参数可以省略，省略时实参以默认值替代2.2.4. API文档的查询方法1. 先根据所要查询的功能找到对应的类库。 对于通用功能，如：模型比较、模型检查、系统参数设置等，请查找PdCommon类库； 对工作空间的操纵，请查找PdWSP类库 对知识库的操纵，请查找PdRMG类库 对某一种模型的操纵，请查找相应模型类库2. 在类库中，进一步对所要查询的功能进行分类，查找对应的类。一般地，PowerDesinger中的一个组件、模型或模型的子元素，都有各自对应的API

15、类。常见的有： 工作空间有对应的Workspace类； 工作空间下的文件夹和模型有对应的WorkspaceFolder类和WorkspaceModel类； 每种模型都对应于各自的类库下的Model类； 模型中包含的子元素如：PDM模型的表、字段等都有相应的Table类、Column类；3. 在类文档中，根据应用场景和使用需求，查找适合的属性、集合和方法。可以按CTRL+F输入关键字在类文档中直接搜索，对找到的内容进行过滤。一般的经验有： 客户端中可以看到的对象属性，在API的类中都有相应的属性 名称以“s”结尾的复数形式的对象，在API类中都可以找到相应的集合类型的成员。集合可以方便地通过“F

16、or Each variable In collection”的语法进行遍历。例如：客户端的PDM模型树的Tables节点，对应于PdPDM类库下的Model类的Tables成员，通过该集合可以取得模型目录树根目录下的所有Table对象。 类的方法从功能上可分为取值、设值和执行3种类型。 取值类型的方法一般以“Get”和“Find”开头。前者返回单个对象的值，后者返回的是对象集合。 设值类型的方法通常以“Set”、“Add”开头。前者设置单个对象的值，后者通常是往集合中新添加对象。2.3. 常用API简介2.3.1. Basic elements - 基础元素2.3.1.1. Collecti

17、ons 集合集合类型代表了某一种对象的集合，很多模型类的下级成员都是集合类型，如PDM模型类(PdPDM.model)的表集合(Tables)、视图集合(Views)、域集合(Domains)。所有集合都能够通过“For Each variable In collection”的语法进行遍历。集合说明Read Only collections(ObjectSet) 此集合只读Unordered collections (ObjectBag)这种集合只能在集合队列的末尾插入新元素Ordered collections (ObjectCol)这种集合可以在集合队列的任意位置插入新元素2.3.1.2

18、. Structured types 结构体类型结构体类型主要用于对模型图表(diagram)中符号(symbol)元素的定位。结构体说明Points定义了最基本的位置元素“点”的结构Rectangles定义了由点组成的矩形的结构Lists-Of-Points定义了点的列表，以及列表的操纵方法2.3.1.3. Global properties 全局属性全局属性是由PowerDesigner客户端的脚本执行环境提供的全局变量，用于设置和返回当前运行环境下的特定属性或对象，以下是所有全局属性的介绍。全局属性说明ActiveDiagram被激活的图表对象ActivePackage被激活的包对象Ac

19、tiveModel被激活的模型对象ActiveGlossary被激活的GLM对象ActiveSelection被激活的图表中选中的符号元素集合，此集合只读ActiveWorkspace工作空间的对象MetaModel当前PowerDesigner客户端程序的元模型对象Models当前所有打开的模型的集合，此集合只读ValidationMode打开或关闭模型校验功能InteractiveMode设置PowerDesigner客户端的交互模式UserName当前登录知识库的用户名称RepositoryConnection当前知识库的连接对象，可用于操纵当前知识库ScriptInputParamet

20、ers只读属性，ExecuteCommand函数执行内部脚本时使用ScriptInputArray只读属性，ExecuteCommand函数执行内部脚本时使用ScriptResult只读属性，ExecuteCommand函数执行内部脚本时使用ShowMode设置当前PowerDesigner客户端程序的可视状态MainWindowHandle提供当前PowerDesigner客户端程序的访问句柄Locked设置OLE方式启动的PowerDesigner客户端，在主程序执行完成后是否保持运行或关闭PicturesTransparentColor设置当前所有IconPicture对象的色彩透明度V

21、iewer只读属性，显示当前PowerDesigner客户端程序是否处于功能受限的观察者模式UserDataDictionary一个全局的集合对象，用于存放用户自己的数据字典2.3.1.4. Global constants 全局常数全局常数是由PowerDesigner客户端的脚本执行环境提供的全局常量，包括当前运行环境中的环境变量和模型创建、PowerDesigner客户端交互等相关的各种常数。以下仅列出部分常用常数，全部的全局常数请查询API帮助文档的相关章节。全局常数说明Version当前PowerDesigner客户端程序的版本号HomeDirectory当前PowerDesigne

22、r客户端程序的所在的全路径RegistryHome当前PowerDesigner客户端程序在注册表local-machine或current-user目录下的相对路径omf_Default模型打开方式：默认方式(OpenModel/CreateModel函数)omf_DontOpenView模型打开方式：创建后不打开Diagram窗口(CreateModel函数)omf_QueryType模型打开方式：强制询问初始Diagram类型omf_NewFileLock模型打开方式：自动创建并锁定相关模型文件(CreateModel函数)omf_Hidden模型打开方式：不在工作空间中显示创建的模型(

23、OpenModel/CreateModel函数)im_BatchPowerDesigner客户端的交互模式：不显示任何对话框并自动采用默认值（这是默认交互模式）im_DialogPowerDesigner客户端的交互模式：总是显示对话框im_AbortPowerDesigner客户端的交互模式：不显示任何对话框但是取消使用默认值cls_. As Long类型标识，常数名称为cls加上对象的类型。例如：PdPDM类库下的Model类的类型标识是PdPDM.cls_Model。要获得完整的类型标识，请查询API帮助文档的AppendixClasses IDs章节2.3.1.5. Global fu

24、nctions 全局函数全局函数是由PowerDesigner客户端的脚本执行环境提供的全局函数，提供全局或通用功能的实现，如模型的创建与打开、文件导入、消息输出、编码方式的转变等。以下仅列出部分常用常数，全部的全局函数请查询API帮助文档的相关章节。全局函数说明CreateModel( modelkind As Long, filename As String = , flags As Long =omf_Default) As BaseObject创建一个新模型。必须参数modelkind指定模型的类型标识；可选参数filename指定模型保存的路径及文件名，可选参数flags指定了模型的

25、创建方式，取值请参考常数：omf_Default、omf_DontOpenView、omf_QueryType、omf_NewFileLock、omf_HiddenCreateModelWithDialog( modelkind As Long, modelname As String = , flags As Long =omf_Default) As BaseObject启动模型创建对话框，必须参数modelkind指定模型类型，可选参数modelname指定模型默认的文件名，用户可以从对话框中修改文件保存的路径及文件名，但不能改变模型类型。可选参数flags指定了模型的创建方式，取值请参

26、考常数：omf_Default、omf_DontOpenView、omf_QueryType、omf_NewFileLock、omf_HiddenCreateModelFromTemplate( filename As String, flags As Long =omf_Default) As BaseObject通过指定的模板来创建模型。必须参数modelkind指定模型的类型标识；可选参数filename指定模型保存的路径及文件名，可选参数flags指定了模型的创建方式，取值请参考常数： omf_DontOpenView、omf_HiddenOpenModel( filename As

27、String, flags As Long =omf_Default) As BaseObject打开一个模型文件。必须参数filename指定模型保存的路径及文件名；可选参数flags指定了模型的打开方式，取值请参考常数： omf_DontOpenView、omf_HiddenOutput(message As String = )在PowerDesigner客户端的Output栏输出字符串内容ConvertToUTF8(InputFileName As String, OutputFileName As String)将InputFileName参数指定的文件转换成UTF8格式保存成Out

28、putFileName参数指定的文件。输入文件和输出文件不能是同一个文件2.3.2. Libraries 类库2.3.2.1. 全部类库类库描述PdCommon通用类库，定义了所有模型通用的组件类PdWSP工作空间类库PdRMG知识库类库PdGLMGLM模型类库PdPDMPDM模型类库PdBPMBPM模型类库PdCDMCDM模型类库PdLDMLDM模型类库PdILMILM模型类库PdFRMFRM模型类库PdPRJPRJ模型类库PdEAMEAM模型类库PdIAMIAM模型类库PdMTMMTM模型类库PdOOMOOM模型类库PdRQMRQM模型类库PdXSMXSM模型类库2.3.2.2. PdCo

29、mmon类库抽象类Class名称描述AbstractRequirement这个抽象类代表与设计对象有关的需求，需求文本存储在标准描述属性，以RTF格式存储，使用Rtf2ascii（）全局函数查看不带格式的文本ArrowSymbol一个内部类，可以链接绘图上的箭头BaseActivity该类用于UUM的活动（UML活动图）和BPM的过程BaseActivitySymbol该类用于OOM中的活动符号（UML活动图）BPM的过程BaseArea一个抽象类，可以用自定义的语义分组对象，该地区和其他对象不是母/子关系，而是简单的关联，通过这种方法，一个对象可以依赖对个方面BaseAssociationM

30、apping该类用来映射源文件和链接对象，像关联和引用。获取父类、类名、类ID、对象表类型、文件夹、对象位置等相关属性BaseCheckNamedClassifier为命名对象提供约束定义和对象映射BaseCheckNamedStructuralFeature为命名子对象提供约束定义和对象映射BaseClassifierMapping映射源文件到对象，通过名字取得属性BaseComposite公共抽象类，用于不是包但是可以分解为子图的对象。像BPM中的进程、OOM中的类、接口和活动。BaseCompositeClassifier为复合对象提供映射的基础抽象类BaseCompositeDataStructure对应一个拥有一系列属性的概念或者物理数据实体，如果Barker符号已经被使用，这个对象可以变成混合物，这种情况