ChangeSummary提供了访问数据图中数据对象的更改历史信息的机制。
更改历史覆盖了一个数据图自日志被激活开始的所有修改情况。如果日志不再处于激活状态,那么日志仅仅包括日志被冻结前的变更。否则它仅仅包括ChangeSummary被查询以来的变更情况。尽管只有在日志激活时,变更信息才开始被采集,但是无论无论日志被激活还是被关闭,你都可以查询变更信息。所有查询返回的信息都是只读的。
该接口具有下列方法:
beginLogging()方法清除ChangeSummary中变更DataObject的列表并且启动一个更改日志。endLogging()方法停止更改日志。undoChanges()方法在日志开始时重建DataObject树,undoChanges()方法同时也清除日志,但是对isLogging()方法没有任何影响。
注意:beginLogging(), endLogging()以及 undoChanges()方法基本上是给服务实现使用的,这是由于服务定义了如何将ChangeSummary的处理与外部资源进行关联。ChangeSummary如果不能捕获产生的变更,这将可能会引起服务基于ChangeSummary的不完整信息去执行数据源的更新。
ChangeSummary的作用范围被定义为自ChangeSummary根开始的DataObject树所包含的所有数据对象。ChangeSummary根对象是所有变更被跟踪的源DataObject。可以通过getRootObject()方法获取ChangeSummary根对象。该对象是下列之一:
使用getOldValues(DataObject dataObject)方法可以取得一个旧值列表。旧值的返回顺序由实现具体决定。对于一个被删除的DataObject,旧值列表包含了该DataObject的所有属性。对于一个已经被修改过的DataObject来说,旧值列表仅仅包含被修改的属性。对于那些没有被删除和修改的DataObject来说,旧值列表为空。
旧值被描述为ChangeSummary.Setting对象(ChangeSummary.Setting是ChangeSummary的一个内部接口)。每一个ChangeSummary.Setting都有一个属性和一个值,同时还有一个用于指明属性是否为集合的标记。
如果一个DataObject 被删除或修改,那么getOldValue(DataObject dataObject, Property property)方法将返回一个用于描述指定属性的ChangeSummary.Setting,否则,它将返回null。如果旧值的setting.isSet()方法返回false,则该旧值没有任何意义。
在日志开始时,getOldSequence(DataObject dataObject)方法将返回一个数据对象顺序的全部值。返回值可能为null。如果DataObject.getSequence()方法返回null,那么getOldSequence(DataObject dataObject)方法将返回null。
当ChangeSummary被反序列化时,如果XML文件中有<changeSummary>元素,那么其日志状态将为on,除非changeSummary标记日志为off。在下列条件下,一个序列化器必须在XML文件中生成一个<changeSummary>元素:
日志的状态被记录进changeSummary元素的logging属性。
ChangeSummary的序列化在日志启动时,包含了足够多的用来重构DataObject初始信息的信息。当日志启动时,新创建的数据图中的属性标签DataObject将不会被显示出来,删除的包含在ChangeSummary中的属性标签对象将不再包含在数据图中。标签可以是IDs,如果可用的话,也可以是sdo路径表达式。
ChangeSummary元素的内容可以是一个被删除的数据对象的深拷贝,也有可能是一个数据对象的原型,该原型仅仅拥有数据类型的变更以及已经改变过的属性的值。
有两种可能的方式用于关联DataObject与ChangeSummary:
1、1、DataGraph使用getChangeSummary()方法获取一个ChangeSummary。
该方法通常在对于DataObject 树而言ChangeSummary为外部的情况下采用。ChangeSummary从根数据对象开始跟踪数据对象树的变化,根数据对象可以通过DataGraph的 getRootObject()方法获得。
2、DataObject的类型能够包括一个用于包含ChangeSummary的属性。
该方法常被用在ChangeSummary是DataObject树的一部分的情形下,例如当一个根DataObject是一个消息头,该消息头同时包含DataObject以及 ChangeSummary这二者的消息体。ChangeSummary从包含该ChangeSummary的DataObject开始跟踪DataObject树的变化。
ChangeSummary接口提供了下列方法:
public interface ChangeSummary
{
void beginLogging();
void endLogging();
boolean isLogging();
void undoChanges();
DataGraph getDataGraph();
DataObject getRootObject();
List /*DataObject*/ getChangedDataObjects();
boolean isCreated(DataObject dataObject);
boolean isDeleted(DataObject dataObject);
boolean isModified(DataObject dataObject);
DataObject getOldContainer(DataObject dataObject);
Property getOldContainmentProperty(DataObject dataObject);
Sequence getOldSequence(DataObject dataObject);
public interface Setting
{
Object getValue();
Property getProperty();
boolean isSet();
}
Setting getOldValue(DataObject DataObject, Property property);
List /*Setting*/ getOldValues(DataObject dataObject);
}