[zt]EMF.Edit编程学习笔记之一: Item Provider机制

FROM:http://www.blogjava.net/eclipshine/archive/2005/07/29/8754.html

（注：大部分翻译，整理自Eclipse Modeling Framework: A Developer's Guide一书的第3.1, 3.2节的内容）

Porvider的概念<o:p></o:p>

对于JFace部分的内容已经比较清楚，这里重点看一下Eclipse中PropertySheet是如何实现的。这涉及到了三个接口，IPropertySourceProvider，IPropertySource，IPropertyDescriptor。而模型对象如果要能够与PropertySheet进行交互，则必须实现IPropertySource接口。Eclipse能够自动的通过IPropertySourceProvider（当然也不是自动，用到了Eclipse中的Adapter技术），取得这个实现了IPropertySource的模型对象，并让PropertySheet对其进行调用。IPropertySource的getPropertyDescriptors()方法取得所有的属性描述对象，属性描述对象定义了一个显示在PropertySheet中的属性的名称等一些相关的性质。IPropertySource中的其它方法，提供了对属性值的显示与修改的方法。

<o:p></o:p>

<v:shapetype id="_x0000_t75" path=" m@4@5 l@4@11@9@11@9@5 xe" o:preferrelative="t" filled="f" stroked="f" coordsize="21600,21600" o:spt="75"><v:stroke joinstyle="miter"></v:stroke><v:formulas><v:f eqn="if lineDrawn pixelLineWidth 0 "></v:f><v:f eqn="sum @0 1 0 "></v:f><v:f eqn="sum 0 0 @1 "></v:f><v:f eqn="prod @2 1 2 "></v:f><v:f eqn="prod @3 21600 pixelWidth "></v:f><v:f eqn="prod @3 21600 pixelHeight "></v:f><v:f eqn="sum @0 0 1 "></v:f><v:f eqn="prod @6 1 2 "></v:f><v:f eqn="prod @7 21600 pixelWidth "></v:f><v:f eqn="sum @8 21600 0 "></v:f><v:f eqn="prod @7 21600 pixelHeight "></v:f><v:f eqn="sum @10 21600 0 "></v:f></v:formulas><v:path o:extrusionok="f" o:connecttype="rect" gradientshapeok="t"></v:path><o:lock aspectratio="t" v:ext="edit"></o:lock></v:shapetype>

图摘自（Eclipse Modeling Framework: A Developer's Guide）<o:p> </o:p>

因此可以看到，要实现一个Tree Viewer，则必须有一个实现了ITreeContentProvider 接口的对象为其提供内容，有一个ILabelProvider接口对象为其提供显示的标签和图标。对于PropertySheet也是如此，必须有一些实现了IPropertyDescriptors()接口的对象来提供被编辑的属性描述。EMF.Edit要做的就是这样的一个工作：它为EMF模型对象，为这些不同的Viewer生成Provider，使得EMF模型对象能够通过那些Viewer进行显示与编辑。EMF.Edit能够通过两种方式来完成这样的工作，反射机制，以及代码生成的机制。并且EMF.Edit允许方便的更改所生成的代码，使得其能够满足特定的要求。

<o:p></o:p>

EMF.Edit中对EMF模型对象的改变，都是通过一种通用的机制：Command来实现的。EMF.Edit提供了对一些常见的Command的实现，并可支持自定义的Command。从上面的讨论可以大概的了解到，EMF.Edit提供的是在Eclipse的界面（JFace, PropertySheet, etc）同EMF模型对象之间的一个桥梁，使得能够通过Eclipse UI来显示和修改EMF所定义的模型对象。EMF.Edit分为两个部分：

1.         org.eclipse.emf.edit: 提供的是底层的与界面无关的部分。

2.         org.eclipse.emf.edit.ui: 提供的是与Eclipse UI相关的实现类。

<o:p></o:p>

在EMF.Edit中最重要的概念是Item Provider。EMF.Edit使用一种代理机制，使得大部分与模型对象相关的功能都最终被代理到相关的Item Provider上了。因此Item Provider需要完成下面这4种主要的功能：

1.         实现content 和label provider 的功能。

2.         为EMF objects提供PropertySource的功能。

3.         作为Command Factory为模型对象创建相关的Command。

4.         将EMF模型改变通知到Viewers。

特定的Item Provider通常通过继承ItemProviderAdapter类来完成全部或者部分的上述功能。Item Provider可以通过代码生成机制被生成后然后进行适当的修改以满足要求；另一方面，EMF.Edit也提供了ReflectiveItemProvider，通过EObject的反射机制实现了上述所有的功能。

<o:p></o:p>

下面看上述的功能是如何在EMF.Edit中被实现的。<o:p></o:p>

<o:p></o:p>

实现content 和label provider 的功能<o:p></o:p>

EMF.Edit提供了通用的AdapterFactoryContentProvider和AdapterFactoryLabelProvider实现。也就是说对于一个TableViewer而言，它使用AdapterFactoryContentProvider和AdapterFactoryLabelProvider作为其ContentProvider和LabelProvider。AdapterFactoryContentProvider等再将请求转发到具体的Item Provider上。转发的过程如下所示，在AdapterFactoryContentProvider中实现的ContentProvider所定义的getChildren()方法：

       public Object[] getChildren(Object object) {<o:p></o:p>

              ITreeItemContentProvider adapter = (ITreeItemContentProvider) adapterFactory<o:p></o:p>

                            .adapt(object, ITreeItemContentProvider.class);<o:p></o:p>

              return adapter.getChildren(object).toArray();<o:p></o:p>

       }<o:p></o:p>

AdapterFactoryContentnProvide通过其adapterFactory，将模型对象object适配到ITreeItemContentProvider上（注意ITreeContentProvider和ITreeItemContentProvider名称上的区别），然后调用相应的方法。这里用到的adapter的模式，在Eclipse和EMF中使用的非常广泛。

<o:p> </o:p>

图摘自（Eclipse Modeling Framework: A Developer's Guide）<o:p> </o:p>

ITreeContentProvider和ITreeItemContentProvider虽然名称上有区别，但其实际上功能是类似的，EMF中之所以引入ITreeItemContentProvider，是为了避免对JFace这样的UI包的依赖，使得其能够用到其它的非UI或者非JFace的环境中。这样的接口有：

l         ITreeItemContentProvider

l         IStructuredItemContentProvider

l         ITableItemLabelProvider

l         IItemLabelProvider

分别对应于JFace中去掉了Item后的接口。

<o:p></o:p>

为EMF objects提供PropertySource的功能<o:p></o:p>

AdapterFactoryContentProvider实际上也实现了IPropertySourceProvider接口，使用如上所述的相同的方式，将模型对象适配到一个IItemPropertySource接口上，对应于IPropertySource。另外的一个EMF类PropertySource通过封装IItemPropertySource实现了PropertySheet所需要的的IPropertySource接口，并被AdapterFactoryContentProvider所返回。同样的模式被使用到生成IPropertyDescriptor的EMF实现PropertyDescriptor上。下面的这个图可以比较清楚的看到这样的关系。

<o:p> </o:p>

图摘自（Eclipse Modeling Framework: A Developer's Guide）

<o:p></o:p>

作为Command Factory为模型对象创建相关的Command<o:p></o:p>

EMF有其自生的Command框架。在这个框架中，EditingDomain是一个类是于JFace中的Provider的接口，提供对Command的创建。并且，EMF.Edit也有一个实现了这个接口的AdapterFactoryEditingDomain，并将请求转发到被适配的IEditingDomainItemProvider对象上。

<o:p></o:p>

将EMF模型改变通知到Viewers<o:p></o:p>

Item Provider作为标准的EMF Adapter，当被适配的模型对象发生改变的时候Item Provider的notifyChanged()会被调用。实际上，ItemProvider的notifyChange()只是将请求（经过过滤后）转给相应的ItemProviderAdapterFacotry，使得其作为模型事件注册及响应的中心。如下图所示：

<o:p> </o:p>

图摘自（Eclipse Modeling Framework: A Developer's Guide）

<o:p></o:p>

需要注意的是，在这样情景下，作为内容显示部分的Viewer并不是事件监听者，相应的Provider对象才是，它监听事件，并调用Viewer的update()方法以刷新显示的内容。