监控生产线集成框架详细设计v1

软件工程研究方向监控软件生产线详细设计文档变更记录变更版本日期图表、表格、段落号A/M/D原因与修改情况描述修订人审核人1.02007-12A创建尹铨1.12008-7M更换模板尹铨注：A 增加 M 修改 D 删节请不要删除后面的分节符II目录目录第1章 引言11.1. 编写目的11.2. 背景11.3. 参考资料1第2章 集成框架的结构2第3章 集成框架的模块设计说明33.1. 注释设计33.2. 模块1-人机交互界面扩展模块33.2.1.描述33.2.2.功能33.2.3.流程逻辑43.2.4.尚未解决的问题43.3. 模块2-工具注册与资源库组织43.3.1.描述43.3.2.功能43.3.3.流程逻辑53.3.4.尚未解决的问题53.4. 模块3-工具生命周期管理模块53.4.1.描述53.4.2.功能53.4.3.流程逻辑63.4.4.尚未解决的问题63.5. 模块4-生产线流程配置模块63.5.1.描述63.5.2.功能63.5.3.流程逻辑73.5.4.尚未解决的问题73.6. 模块5-生产线生命周期管理模块73.6.1.描述73.6.2.功能73.6.3.流程逻辑83.6.4.尚未解决的问题83.7. 模块6-协同开发集成扩展模块83.7.1.描述83.7.2.功能83.7.3.流程逻辑83.7.4.尚未解决的问题83.8. 模块7-数据集成与交互管理模块83.8.1.描述83.8.2.功能93.8.3.流程逻辑93.8.4.尚未解决的问题93.9. 模块8-XML解析模块93.9.1.描述93.9.2.功能93.9.3.流程逻辑93.9.4.尚未解决的问题9参考文献10请不要删除后面的分节符XXXXXX研究方向 XXX文档软件生产线集成框架详细设计文档第1章 引言1.1. 编写目的 编写软件生产线集成框架详细设计文档是为了使集成框架开发人员了解集成框架模块组成和接口规范，并以此为指南开发集成框架。1.2. 背景说明：待开发的软件系统的名称：软件生产线集成框架；1.3. 参考资料列出要用到的参考资料，如：a 可信的国家软件资源共享与协同生产环境项目申请书；第2章 集成框架的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。概要设计中的集成框架平台无关模型图概要设计中的集成框架平台映射到Eclipse平台上的模型图第3章 集成框架的模块设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。3.1. 注释设计说明准备在本程序中安排的注释，如：a 加在模块首部的注释；b 加在各分枝点处的注释；c 对各变量的功能、范围、缺省条件等所加的注释；d 对使用的逻辑所加的注释等等。本部分参见wiki平台上的项目工程源码注释风格说明：10:8080/confluence/pages/viewpage.action?pageId=21955393.2. 模块1-人机交互界面扩展模块3.2.1. 描述参见概要设计。3.2.2. 功能提供集成框架的可视化操作，其中界面包括：1) 透视图：集成框架透视图2) 视图：左侧：工具资源库管理视图、软件生产流程视图、生产线状态控制视图右侧：生产线流程配置、控制台3.2.3. 流程逻辑启动Eclipse后，若集成框架插件已加载，则可以通过打开集成框架透视图，进入集成框架编辑操作区域。透视图默认显示（左上）工具资源库管理视图、（左下）生产线状态控制视图、（右上）生产线流程配置、（右下）控制台视图。3.2.4. 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.3. 模块2-工具注册与资源库组织3.3.1. 描述参见概要设计。3.3.2. 功能提供工具注册和管理的可视化操作，其中界面包括：工具资源库管理视图，在此视图中显示资源库中已有工具，并可通过右键点击进行工具的启动、停止、卸载等操作。如同Eclipse中的插件视图一样，在此我们仅显示被集成框架所识别的工具，而不停留在插件级别。关于工具的注册功能，目前方案是通过将插件工具放入repository文件夹，然后集成框架扫描repository文件夹进行工具发现并注册，并在集成框架中的spl.repository.xml文件中对工具进行登记。然后显示到工具资源库管理视图中，其中spl.repository.xml内容举例如下： 18 lucene-1.4.3 file:/E:教研室707项目软件生产线插件框架原型参考TPFTPF-distTPFtoolslucene-1.4.3.jar 6 2 3.3.3. 流程逻辑打开工具资源库管理视图后会显示目前资源库中所有的工具，并可通过右键对其进行操作。3.3.4. 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.4. 模块3-工具生命周期管理模块3.4.1. 描述参见概要设计。源码中包名：.spl.framework.tmf (tmf即为tool manage framework的缩写)3.4.2. 功能提供工具生命周期管理的可视化操作，其中界面利用工具资源库管理视图，在此视图中显示资源库中已有工具，并可通过右键点击进行工具的启动、停止、卸载等操作。3.4.3. 流程逻辑业务逻辑实现中仿照Eclipse产品配置视图中对插件进行生命周期管理一样，实现对工具的生命周期的管理。3.4.4. 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.5. 模块4-生产线流程配置模块3.5.1. 描述参见概要设计。3.5.2. 功能提供对生产线流程的可视化定制，其中利用的界面包括了生产线流程配置视图和软件生产流程视图。在生产线流程配置视图中可根据资源库中的工具实现对一条生产线生产流程的定制，并可通过策略规定生产线流程的迭代性（例如从流程3可以回退到流程2，流程4禁止回退到流程1等，难点！）此处应再定义一个生产线流程及策略配置XML文档spl.workflow.xml！定制生产流程后，更改spl.workflow.xml中相应工具的0，并将生产线流程使用的工具按序显示到软件生产流程视图中，如图所示：3.5.3. 流程逻辑进入生产线流程配置视图后，根据资源库中的现有工具对生产线流程进行配置，并维护spl.workflow.xml文件，订制生产线流程。3.5.4. 尚未解决的问题生产线流程配置视图如何利用工具进行配置流程？！流程迭代策略如何实现？！ 3.6. 模块5-生产线生命周期管理模块3.6.1. 描述参见概要设计。3.6.2. 功能提供对生产线生命周期的管理，并显示当前生产线状态，例如共有几步流程，目前进行到第几个流程，并在左下部分的生产线状态控制视图中进行相应的显示（最好是图形显示，视图中应包括生产线流程启动和停止两个按钮）。生产线生命周期的管理包括了生产线流程的启动和停止两个操作。3.6.3. 流程逻辑配置完生产流程后，需要对生产流程进行启动。启动生产流程后，会进入生产流程中，并启动第一个流程工具；停止时，则会关闭全部软件生产流程，此时在左下部分的生产线状态控制视图中进行相应的显示。3.6.4. 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.7. 模块6-协同开发集成扩展模块3.7.1. 描述参见概要设计。3.7.2. 功能提供集成框架的协同开发功能，集成了一些常用的协同开发工具，如subclipse、EclipseTeam模块、日历模块、邮件模块、浏览器模块等，建议采用开源组件实现，但整合到一个菜单中，此处需扩展生产线菜单。3.7.3. 流程逻辑为生产线工具提供协同开发辅助性功能，如团队开发、版本控制，浏览器集成等。3.7.4. 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.8. 模块7-数据集成与交互管理模块3.8.1. 描述参见概要设计。3.8.2. 功能提供集成框架对生产线中的数据流进行解析传递的功能，主要实现对工具定义的输入输出XML文档的解析，并将工具输出传递给下一个工具，本模块利用底层的XML解析模块提供了对生产线中常用xml文档的解析和操作功能。3.8.3. 流程逻辑其他模块在实现对xml操作时调用本模块中的xml解析接口。3.8.4. 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。3.9. 模块