ImprovementinDataManager软件设计文档范例

数据管理模块（Data Manager）新
增功能说明书
文档负责人：朱金清
文档编写人：朱金清
文档系统版本号：OrientX Version 3.0
文档完成时间：2007/8/25
开发单位：中国人民大学IDKE实验室XML工作组
1.概述
本模块介绍数据在OrientX系统中的管理，包括数据的存储方法，数据的导入导出，数据的存取等。

向上层查询模块提供接口的是DataManager类。

它通过调用Schema类实现模式文档的解析和数据集的建立，通过调用ImportHandler 类实现XML格式的文档的导入，上层模块利用它的导航接口可以提取想要的数据对象。

由于原来讲schema绑定到数据集中，造成了接下来要完成的更新功能的不便，本文档应运而生。

在schema和数据集分开的前提下，自然也就达到操作上的松耦合。

Schema 的创建和DataSet的创建是两个独立的步骤，同样的删除一个DataSet不再涉及Schema的删除。

所以现在将修改（包括添加）的函数在下面第二部分中陈述。

2.数据结构描述
2.1 NxdbDataManager 类
NxdbDataManager类可以说是这个模块的主要接口的类，它的功能主要有向上层提供管理数据接口，包括：
1)数据集的建立、删除
2)Schema的注册、删除
3)数据文件的导入导出
4)存取查询需要的数据
NxdbDataManager类就是封装了这些功能的接口，下面是NxdbDataManager类的具体实现
1.数据成员
2.成员函数
(2) int ImportDoc(char* dataSetName,char* docName ,char* URL，StorageMode
2007-07-22
CDEBStorageMode
(1)ElementNode* CDEBStorageMode::GetParent( ElementNode* cele )
实现步骤：
1.获取cele的父亲结点，如果父亲节点为ElementNode，则返回，否则执行下一步骤
2.获取父亲结点（为RecordNode），然后读出父亲结点的parent Code Buffer，
3.对CodeBuffer进行解析（ReadDEBRecIndexKey函数）
4.对解析出来的Code的IndexKey（RegionCode32对应的m_start），如果是0，那么当前
结点为根节点，那么根节点的父亲结点为空NULL。

5.通过Code去ElementNodeCache中查找，找到则返回，并修改指针
6.如果找不到，那么利用GetElement（Code*）去Disk中解析出ElementNode，然后修改
相应的指针.
7.ElementNode结点在Cache中不存在，那么将ElementNode加入到Cache中以备下次使
用
(2)ElementNode* CDEBStorageMode::GetFirstChild( ElementNode* cele )
1.首先得到cele的firstChild记作curNode，如果curNode不为空，进行以下三个步骤地
循环体，如果curNode为空那么跳出循环，执行第5步。

2.如果当前结点为ElementNode，那么返回当前结点。

3.如果当前结点为TextNode，那么将curNode指向curNode的右兄弟。

4.如果当前结点为RecordNode，那么跳出循环。

5.如果curNode结点位NULL，那么返回NULL
6.此时当前结点curNode为RecordNode，首先判断curNode->root是否为空，如果不为空，
那么返回的结果为curNode->root，然后修改指针；如果为空，执行以下步骤
7.如果为空，首先根据curNode中的pCode和m_DocID去缓存中查找，如果找到相应的
ElementNode，那么返回的结果为找到的ElementNode，如果找不到ElementNode，那么根据pCode首先去CodeRecAddressIndex中查找出地址，然后根据地址去磁盘中还原出相应的ElementNode，然后返回这个ElementNode
Metadata Manager模块功能说明书1.概述
一个数据库系统，元数据信息的管理应该作为一个单独的模块进行管理，所有在撇开原有数据的捆绑之后，元数据开始有自己的管理家园了。

本模块主要负责元数据（Schema信息）的管理，主要包括Schema的注册，Schema的保存，Schema的加载（导出DTDTree）和Schema的删除功能。

在第二部分详细介绍下Metadata 的各个接口及其实现的细节。

2.数据结构描述
2.1 MetaDataManager类
本类主要负责Schema信息的主要功能实现类，包括系统运行开始时的初始化，然后用户进行的Schema的注册，Schema的保存、删除和加载等操作。

需要注意的是，在Metadata进行保存的同时，因为用户只对Schema URL感知，而对底层的SchamaNO（可以理解成为Schema在系统中的ID号）却一无所知，所以得有一个专门负责管理Schame的登记的工具，简称为Schema URL和ID号的映射表，简称表<URL,SchemaNo>。

对于表<URL,SchemaNo>的管理，本系统借用Bekerley DB进行管理，所以在初始化阶段必须把相应的Bekerley初始化好，然后在进行Schema的注册时要把相应的项加入到Bekerley DB中。

2.2 MetaDataManager的成员函数
(4) void ExportSchema(char* url)
存储模块改进功能设计说明书
1．引言
编写本说明书是为了向读者介绍OrientX系统中，数据存储模块的设计思路及使用方法。

需要注意的是另一个模块：数据存取模块。

虽然这两个模块在名字上只有一字之差，但两个模块在功能作用上有很大的不同。

本模块重点介绍在OrientX系统中四种存储方式的特点和实现。

而数据存取模块重点在数据的导入、导出和存取，及相关的数据模式的建立。

2．总体设计
设计背景：
由于原系统在处理数据存储时，对于不同的存储策略比如DEB或者DSB等，都在同一个函数中实现，通过每个结点的不同类型用Switch…Case语句进行区分，这样给代码阅读和实现以及以后的维护都带来一定的困难，所以提出，各自分工，各行其职的方法，Version3.0版本主要为了实现Update功能，所以只实现了DEB存储策略的储存及其数据获取方法。

设计方案及其总体思想：
1、首先，每个记录的保存发生变化。

同样地，也是利用SAX接口，在遇到相应的字符时调用相应的回调函数，这些处理都与先前的版本一样，但是在endElement时，保存每个记录的数据内容不同，现在，由于脱离了Schema的捆绑约束，而引入了每个TagName对应的全局<ID，Name>影射表。

每个结点需要保存的内容有：（1）父亲结点的Code对应的有效标识（2）当前结点的TagID，Code，（3）孩子结点的Tag，Code对应的有效标识。

具体存储如下：RecLen Type TagID Code ParentCodeKey
大小：Sizeof(int) 1 TAGIDTYPE 2*sizeof(int)+size(short) sizeof(int) Children Information：
Case1(TextNode)：Type ValueType ValueLen Value
1 1
2 valueLen
Case2(RecordNode)：Type TagID CodeKey
1 TAGIDTYPE sizeof(int)
结束标志：‘)’
2、然后，每个文档有一个索引<Code，RecAddress>的索引，所以每次将每个记录存储好之后就将这个记录的Code及其地址加入到索引表中。

这样的话如果某个记录更新了，但是如果存储地址不变的话就不用更新索引表；但是当这个记录变大后，如果存储地址变化了，只需要更新索引表，但是有一个好处就是不用更新其他结点的信息，本来如果一个结点发生更新，那么其他地方引用这个结点的信息照样也要发生更新，而在我们引入了索引表之后，只需要更新这个索引项的内容，而无需动用其他结点的信息。

3、所以，如果数据的存储发生变化，那么对应的数据读取也要发生变化，这个只要按照数据存储时的格式进行顺序解析即可。

注意：数据的存储还是利用原来的EBImpHandler（EBImpNode）的接口，而数据的读取现在隔离出来了，主要是在EBStorageMode类中实现。