blob: 46e2a4acb621d3298a8b7df95d4bb507cbea952a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>EMF Resource Edit Model</title>
<link rel="stylesheet" type="text/css" href="schema.css")
</HEAD>
<BODY>
<H1><CENTER>EMF Resource Edit Model</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>com.ibm.etools.emf.workbench.editModel<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>6.0
<p></p>
<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>Edit models provide a framework for managing a set of EMF resources within a unit of work. For example, a workspace operation may affect a change to multiple EMF resources. Edit models provide basic services such as loads, saves (when necessary), and validate edit for the managed resources. Edit models are reference counted, therefore a single instance of an edit model can be shared by more than one operation or editor. By declaring an edit model, a plugin provider enables other components to contribute resources to be managed by that edit model.</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.editModel">editModel</a>+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.editModel">editModel</a> (<a href="#e.editModelResource">editModelResource</a>+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST editModel</p>
<p class=code id=dtdAttlist>editModelID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>factoryClass&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>loadUnknownResourcesAsReadOnly&nbsp;(true | false) <p class=code id=dtdAttlist>parentModelID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
The declaration for an edit model to be used in the workspace.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>editModelID</b> - A unique identifier for the edit model.</li>
<li><b>factoryClass</b> - An optional factory class that is used for this edit model. The class must implement the interface <code>com.ibm.etools.emf.workbench.edit.EditModelFactory</code>. If none is specified, then a generic <code>EditModel</code> is created.</li>
<li><b>loadUnknownResourcesAsReadOnly</b> - </li>
<li><b>parentModelID</b> - </li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.editModelResource">editModelResource</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST editModelResource</p>
<p class=code id=dtdAttlist>URI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>autoload&nbsp;(true | false) "false"&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
This is an individual contribution of a resource to the edit model. If more than one instance of the same URI is registered against an edit model id, the resource is still only loaded once.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>URI</b> - The URI of the resource relative to the root container from which EMF resources are loaded.</li>
<li><b>autoload</b> - Indicator which determines whether this resource should be autoloaded when the edit model is created, or when an IFile corresponding to this resource is added.</li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6><br>
<code>
&nbsp;&nbsp;&nbsp;&lt;extension<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id="editModel.acme.parent"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name="Acme&nbsp;Parent&nbsp;Edit&nbsp;Model"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point="com.ibm.etools.emf.workbench.editModel"&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;editModel<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;editModelID="com.acme.acmepro.parent.editModel"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;factoryClass="com.ibm.etools.emf.workbench.edit.EditModelFactory"&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;editModelResource&nbsp;URI="DIR/resource0.xml"&nbsp;/&gt;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;editModelResource&nbsp;URI="DIR/resource1.xml"&nbsp;/&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/editModel&gt;<br>
&nbsp;&nbsp;&nbsp;&lt;/extension&gt;&nbsp;<br>
&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&lt;extension<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id="editModel.acme.child"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name="Acme&nbsp;Child&nbsp;Edit&nbsp;Model"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point="com.ibm.etools.emf.workbench.editModel"&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;editModel<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;editModelID="com.acme.acmepro.child.editModel"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;factoryClass="com.ibm.etools.emf.workbench.edit.EditModelFactory"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parentModelID="com.acme.acmepro.parent.editModel"&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;editModelResource&nbsp;URI="DIR/resource2.xml"&nbsp;/&gt;&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;editModelResource&nbsp;URI="DIR/resource3.xml"&nbsp;/&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/editModel&gt;<br>
&nbsp;&nbsp;&nbsp;&lt;/extension&gt;&nbsp;&nbsp;&nbsp;<br>
</code>
<p></p>
<h6 class=CaptionFigColumn id=header>API Information: </h6>Edit Models can be accessed through the com.ibm.etools.emf.workbench.EMFWorkbenchContext.
<p></p>
<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>[Enter information about supplied implementation of this extension point.]
<p></p>
<br>
<p class=note id=copyright>
</p>
</BODY>
</HTML>