platform-vcm-home/docs/online/team3.1/logical-physical-mappings.html

Parent Directory | Revision Log | Patch

-revision 1.3, Fri Feb 11 16:43:57 2005 UTC
+revision 1.4, Fri Feb 11 21:38:21 2005 UTC
 Line 43
      </ul>
    </li>
    <li><strong>ResourceTraversal</strong>: A <a href="http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.core.resources/src/org/eclipse/core/resources/mapping/ResourceTraversal.java?rev=HEAD&content-type=text/vnd.viewcvs-markup"><code>ResourceTraversal</code></a>
-     simply contains a set of resources and a depth flag that indicates the depth
+     contains a set of resources and a depth flag that indicates the depth to which
-     to which the resources in the traversal are associated with the originating
+     the resources in the traversal are associated with the originating model object.
-     model object. Resource traversals are provided to a client by a resource mapping
+     Resource traversals are provided to a client by a resource mapping in order
-     in order to describe the contents of a model in sich a way that a repository
+     to describe the contents of a model in such a way that the client (e.g a repository
-     provider can perform its operations in as efficient a means as possible. Methods
+     provider) can perform its operations in as efficient a means as possible.
-     of interest are:
+     Methods of interest are:
      <ul>
        <li><code>getResources()</code></li>
        <li><code>getDepth()</code></li>
 Line 71
    to get resource specific actions shown in the context menu can now adapt to
    <code>ResourceMapping</code> if a richer description of how the object adapts
    to resources is benefitial. However, they are not required to do so if there
-   is no benefit. For instance a Java class that now currently adapts to <code>IFile</code>
+   is no benefit. For instance a Java compilation unit (i.e. *.java file shown
-   need not adapt to <code>ResourceMapping</code> since nothing is gained. However,
+   in a JDT view) that now currently adapts to <code>IFile</code> need not adapt
-   a Java package should adapt to <code>ResourceMapping</code> in order to indicate
+   to <code>ResourceMapping</code> since nothing is gained. However, a Java package
-   that the package is only the files in the corresponding folder and not the subfolders.</p>
+   should adapt to <code>ResourceMapping</code> in order to indicate that the package
+   is only the files in the corresponding folder and not the subfolders.</p>
  <p>The preferred way to adapt model elements to a resource mapping is to use an
    adapter factory. The following is the XML markup for contributing an adapter
    factory in a plugin manifest. </p>
-Line 93
+Line 94
     }
  }</pre>
  <p>For popup menu contribuions, it is not required that the model objects implement
-   the <code>IAdaptable</code> interface. However, if they do they must ensure
+   the <code>IAdaptable</code> interface. However, if they do, they must ensure
    that the Platform adapter manager is consulted. This can be done by either subclassing
    <code>PlatformObject</code> or by using the following line of code:</p>
  <blockquote>
-Line 134
+Line 135
      contributions to <code>ResourceMapping</code> (for those for which this is
      appropriate).</li>
    <li>Update their actions to work on <code>ResourceMapping</code> instead of
-     IResource and respect the depth constraints provided in the traversals.</li>
+     <code>IResource</code> and respect the depth constraints provided in the traversals.</li>
    <li>(Optional) provide a <code>ResourceMappingContext</code> if they manage
      remote resources (more on this <a href="#ResourceMappingContext">below</a>)</li>
  </ol>
  <p>First of all, plugins that add object contributions to <code>IResource</code>
    (CVS, Search, Compare) can now add them to <code>ResourceMapping</code> instead,
-   if the action can apply to multiple resources. Here is an XML snipet:</p>
+   if the action can apply to multiple resources. Here is an XML snipet that contributes
+   a menu action to objects that adapt to resource mappings:</p>
  <pre style="background-color: rgb(204, 204, 255);">   &lt;extension<br>       point=&quot;org.eclipse.ui.popupMenus&quot;&gt;<br>       &lt;objectContribution<br>            adaptable=&quot;true&quot;<br>            objectClass=&quot;org.eclipse.core.resources.mapping.ResourceMapping&quot;<br>            id=&quot;org.eclipse.example.library.ResourceMappingContributions&quot;&gt;<br>         &lt;action<br>               label=&quot;Show Resource Mappings&quot;<br>               class=&quot;org.eclipse.example.library.contributions.ShowResourceMappingsAction&quot;<br>               menubarPath=&quot;additions&quot;<br>               id=&quot;org.eclipse.example.library.showMappings&quot;/&gt;         <br>        &lt;/objectContribution&gt;<br>   &lt;/extension&gt;</pre>
  <p>Contributions to <code>ResourceMapping</code> will automatically apply to objects
    that adapt to <code>IResource</code>. This transitive association is handled
    by the Workbench.</p>
  <p>Filtering of the contributions to resource mappings can be done using action
-   filters or expressions although expressions are perferrable. An expression for
+   filters or expressions. An expression for filtering by project persistant property
-   filtering by project persistant property has been added to allow repository
+   has been added to allow repository providers to have their menus appear on projects
-   providers to have their menus appear on projects that are mapped to their repositories.</p>
+   that are mapped to their repositories.</p>
  <pre style="background-color: rgb(204, 204, 255);">   &lt;extension<br>       point=&quot;org.eclipse.ui.popupMenus&quot;&gt;<br>      &lt;objectContribution<br>            objectClass=&quot;org.eclipse.core.resources.mapping.ResourceMapping&quot;<br>            adaptable=&quot;true&quot;<br>            id=&quot;org.eclipse.team.ccvs.ui.ResourceMapperContributions&quot;&gt;<br>             &lt;enablement&gt;<br>           &lt;adapt type=&quot;org.eclipse.core.resources.mapping.ResourceMapping&quot;&gt;<br>              &lt;test
                   property=&quot;org.eclipse.ui.ide.projectPersistentProperty&quot;
                   args=&quot;org.eclipse.team.core.repository=org.eclipse.team.cvs.core.cvsnature&quot; /&gt;<br>           &lt;/adapt&gt;<br>         &lt;/enablement&gt;<br>         &lt;action<br>               label=&quot;%UpdateAction.label&quot;<br>               definitionId=&quot;org.eclipse.team.cvs.ui.update&quot;<br>               class=&quot;org.eclipse.team.internal.ccvs.ui.actions.UpdateAction&quot;<br>               tooltip=&quot;%UpdateAction.tooltip&quot;<br>               menubarPath=&quot;team.main/group2&quot;<br>               id=&quot;org.eclipse.team.cvs.ui.update&quot;&gt;<br>         &lt;/action&gt;
-Line 183
+Line 185
    be included when updating. However, the resources that constitute some logical
    models may change over time. For instance, the resources that constitute a model
    element may depend of the contents of a manifest file (or some other similar
-   mechanism). In order for the ResourceMapping to return the proper traversal,
+   mechanism). In order for the resource mapping to return the proper traversal,
    it must access the remote contents of the manifest file (if it differes from
    the local contents) in order to see if there are additional resources that need
    to be included. These additional resources may not exist in the workspace but
-Line 204
+Line 206
    be described as a folder of depth of one so a resource mapping for java packages
    would not ned to make use of the resource mapping context. </p>
  <p>As a more complicated example, consider an HTML file that contains several
-   images. Let's mak the assumption that any images references from an HTML file
+   images. Let's make the assumption that any images references from an HTML file
-   ae part of the model of that file. When updating the local contents of the HTML
+   are part of the model of that file. When updating the local contents of the
-   file from a repository, the user would expect that any new images would be included.
+   HTML file from a repository, the user would expect that any new images would
-   The getTraversals method for a ResourceMapping for the HTML file model would
+   be included. The <code>getTraversals</code> method for a <code>ResourceMapping</code>
-   look something like this:</p>
+   for the HTML file model would look something like this:</p>
  <pre style="background-color: rgb(204, 204, 255);">public class HTMLResourceMapping extends ResourceMapping {
     private HTMLFile htmlFile;
     getTraversals(ResourceMappingContext context, IPorgressMonitor monitor) {
-       IResource[] resources = htmlFile.getRsources();
+       IResource[] resources = htmlFile.getResources();
        if (context != null) {
           // Look for any additional resources on the server
           IFile file = htmlFile.getFile();
-Line 229
+Line 231
  <h4>When does a client need to provide a ResourceMappingContext?</h4>
  <p>Any client that is providing the ability of sharing workspace resources through
    a repository and is supporting ResourceMappings should provide an appropriate
-   context for determining the relevant remote state o the model resources. The
+   context for determining the relevant remote state of the model resources. The
    context provides three basic quieries:</p>
  <ul>
    <li>Does the local contents differ from the remote contents</li>

 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.4
 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.4
-Removed from v.1.3
+Added in v.1.4

help@eclipse.org	ViewVC Help
Powered by ViewVC 1.0.3

Eclipse

platform-vcm-home/docs/online/team3.1/logical-physical-mappings.html