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

Parent Directory | Revision Log | Patch

-revision 1.8, Tue Feb 22 14:26:18 2005 UTC
+revision 1.9, Fri Feb 25 16:18:02 2005 UTC
 Line 46
      contains a set of resources and a depth flag that indicates the depth to which
      the resources in the traversal are associated with the originating model object.
      Resource traversals are provided to a client by a resource mapping in order
-     to describe the contents of a model in such a way that the client (e.g a repository
+     to describe the contents of a model in such a way that the client (e.g. a
-     provider) can perform its operations in as efficient a means as possible.
+     repository provider) can perform its operations in as efficient a means as
-     Methods of interest are:
+     possible. Methods of interest are:
      <ul>
        <li><code>getResources()</code></li>
        <li><code>getDepth()</code></li>
 Line 70
  <p>Plugins that adapted their model objects to <code>IResource</code> in order
    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
+   to resources is beneficial. However, they are not required to do so if there
    is no benefit. For instance a Java compilation unit (i.e. *.java file shown
    in a JDT view) that now currently adapts to <code>IFile</code> need not adapt
    to <code>ResourceMapping</code> since nothing is gained. However, a Java package
 Line 93
        return new Class[] {ResourceMapping.class};
     }
  }</pre>
- <p>For popup menu contribuions, it is not required that the model objects implement
+ <p>For popup menu contributions, it is not required that the model objects implement
    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>
    <p><code>Platform.getAdapterManager().getAdapter(Object, Class)</code></p>
  </blockquote>
- <p>The above is the preferrable approach. However, the model object can implement
+ <p>The above is the preferable approach. However, the model object can implement
    the IAdaptable interface and provide a <code>getAdapter(Class)</code> implementation
    that creates returns an instance of <code>ResourceMapping</code> explicitly
    when asked for one. This is a more straightforward approach but the least desirable
 Line 112
    for this purpose. When objects are being adapted to <code>IResource</code> in
    the context of object contributions, the workbench first tries to adapt the
    resource to <code>IContributorResourceAdapter</code> before trying to adapt
-   to <code>IResource</code> directly. A new sub-iterface of this interface, <code>IContributorResourceAdapter2</code>,
+   to <code>IResource</code> directly. A new sub-interface of this interface, <code>IContributorResourceAdapter2</code>,
    has been added which provides the same capability for <code>ResourceMapping</code>.
-   The only difference is that the model provider shoudl register a factory for<code>
+   The only difference is that the model provider should register a factory for<code>
    IContributorResourceAdapter</code> since the Workbench does an <em>instanceof</em>
    check to see if the contributed adapter is also an instance of <code>IContributorResourceAdapter2</code>.</p>
  <p>The implementation of the <code>ResourceMapping</code> subclass for a Java
 Line 135
        }
     }
  }</pre>
- <p>This is a fairly straightforward mapping so the implementaion is not complex.
+ <p>This is a fairly straightforward mapping so the implementation is not complex.
    The complexity of the resource mapping implementation will, of course, vary
    from model to model. The <code>EMFResourceMapping</code> example used above
    is implemented in the example and it a much more complicated implementation.</p>
 Line 153
  </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 that contributes
+   if the action can apply to multiple resources. Here is an XML snippet 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. An expression for filtering by project persistant property
+   filters or expressions. An expression for filtering by project persistent property
    has been added to allow repository providers to have their menus appear on projects
    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
 Line 177
    resource and the depth as input into an operation that the action delegates
    to do the work. As an example, if the user performs a CVS update on a java package
    and the java package resource mapping maps to a folder of depth one, CVS would
-   issue an appropriat command (&quot;cvs update -l&quot; for those who are curious)
+   issue an appropriate command (&quot;cvs update -l&quot; for those who are curious)
-   which would perform a shallow update on the folder the pakcage represents.</p>
+   which would perform a shallow update on the folder the package represents.</p>
  <h3><a name="ResourceMappingContext"></a>Resource Mapping Context</h3>
- <p>One of the advantages of a Resouce Mapping API is that it allows plug-ins to
+ <p>One of the advantages of a Resource Mapping API is that it allows plug-ins
-   implement any operations they desire in terms of resource mappings (e.g. CVS
+   to implement any operations they desire in terms of resource mappings (e.g.
-   update, CVS commit, CVS tag, dirty decoration, etc.). However, the API that
+   CVS update, CVS commit, CVS tag, dirty decoration, etc.). However, the API that
    has been introduced so far deals only with the local state of the model. When
    working with a model that may be shared between developers, you end up in a
    situation where the remote state of the model (i.e. the state of the model that
 Line 198
    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 resource mapping to return the proper traversal,
-   it must access the remote contents of the manifest file (if it differes from
+   it must access the remote contents of the manifest file (if it differs 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
    the repository provider would know how to make sure they did when the selected
 Line 212
  <p>A <code>ResourceMapping</code> need only worry about a context supplied to
    the <code>getTraversals</code> method in cases were the resources that make
    up a model change over time and the relationship between the model and resources
-   cannot be described by a simple traversal that is gauranteed to encompass those
+   cannot be described by a simple traversal that is guaranteed to encompass those
-   resources (and only those resources) that consitute the model. For example,
+   resources (and only those resources) that constitute the model. For example,
    although the resources of a Java package may change over time, the package can
    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>
 Line 241
     }<br>}</pre>
  <p>Notice that there are two sets of resources included in the model: those derived
-   from the local contents of the HTML file in the worspace and the contents of
+   from the local contents of the HTML file in the workspace and the contents of
    the file remotely. In either of these two sets, there may be resources that
    do not exist in the workspace. For instance, the local HTML file may contain
    a relative link to an image that does not exist in the workspace. This resource
 Line 252
  <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 of the model resources. The
-   context provides three basic quieries:</p>
+   context provides three basic queries:</p>
  <ul>
    <li>Does the local contents differ from the remote contents</li>
    <li>What are the remote contents of a file</li>
-   <li>What are the remote memebers of a folder</li>
+   <li>What are the remote members of a folder</li>
  </ul>
  <p>The answer to the first question above depends on the type of operation that
    is being performed:</p>
 Line 281
    generated by EMF. It requires Eclipse 3.1 M5 and EMF SDK 2.0.1.</p>
  <p> The model is persisted in several types of files:</p>
  <ul>
-   <li>*.library files which contain the name of a library and one ofr more book
+   <li>*.library files which contain the name of a library and one or more book
-     copy records which reference a bokk and indicate the number of copies of the
+     copy records which reference a book and indicate the number of copies of the
      book the libraries contain.</li>
-   <li>*.books files which contain one or more books. Each book has serveral properties
+   <li>*.books files which contain one or more books. Each book has several properties
      (name, number of pages, etc.) as well as a reference to the book's author.</li>
    <li>*.writers files which contain one or more writers. Each writer has properties
-     (e.g. name) as weel as references to one or more books that have been authored
+     (e.g. name) as well as references to one or more books that have been authored
      by the writer.</li>
  </ul>
  <p>The following screenshot shows an example Library.</p>
 Line 296
  <ul>
    <li>My.writers: contains &quot;Bob&quot;</li>
    <li>My.books: contains &quot;The Life of Bob&quot;</li>
-   <li>mylib.library: contains copeis of the &quot;Life of Bob&quot;</li>
+   <li>mylib.library: contains copies of the &quot;Life of Bob&quot;</li>
  </ul>
  <p>For the purposes of this example, model containment is determined by following
    all the references from the file containing the selected model element to all
 Line 304
    would be My.writers, since Bob is contained in that file, and My.books since
    Bob wrote a book in that book catalog. The resources associated with the Main
    Library would be mylib.library, My.books, since the library contains a book
-   from that catalog, and My.writers, since the it contains Bob, the auther of
+   from that catalog, and My.writers, since the it contains Bob, the author of
    that book.</p>
  <p>There are three files of interest in the example code, all of them in the org.eclipse.team.examples.library.adapt
    plugin.</p>
  <ul>
-   <li><em>org.eclipse.team.examples.library.adapt/plugin.xml</em>: containes the
+   <li><em>org.eclipse.team.examples.library.adapt/plugin.xml</em>: contains the
      adapter factory registration and an object contribution to <code>ResourceMapping</code>.</li>
    <li><em>org.eclipse.team.examples.library.adapt/src/org/eclipse/team/examples/library/adapt/EMFResourceMapping</em>:
      The resource mapping from the Library model to resources. This is basically
-     a worst-case mapping that uses EMF to traverse the modle for file references.
+     a worst-case mapping that uses EMF to traverse the model for file references.
      Read the class javadoc for more information.</li>
    <li><em>org.eclipse.team.examples.library.adapt/src/org/eclipse/team/examples/library/adapt/ShowResourceMappingsAction</em>:
-     The action that shows the resource mapping. At the time of writting it uses
+     The action that shows the resource mapping. At the time of writing it uses
      internal Team UI classes but the intention is to make these classes (or at
-     least the funtionality they provide) API in 3.1.</li>
+     least the functionality they provide) API in 3.1.</li>
  </ul>
  <p>There is also a read-me file (<em>org.eclipse.team.examples.library.adapt/readme.html</em>)
    that contains instructions on how to use the example. </p>
 Line 368
    that a model may not make use of the context to determine which resource should
    be included in the mapping. In either case, this is only an issue for models
    that may add or remove resources at the root level. In reality, the number of
-   these cases may be small bu the effects will be noticable since operations may
+   these cases may be small but the effects will be noticeable since operations
-   exclude resources. These cases can be handled by falling back to operations
+   may exclude resources. These cases can be handled by falling back to operations
    on the resources themselves.<br>
  </p>
  </body>

 Legend:



Removed from v.1.8
 


changed lines


 
Added in v.1.9
 Legend:



Removed from v.1.8
 


changed lines


 
Added in v.1.9
-Removed from v.1.8
+Added in v.1.9

help@eclipse.org	ViewVC Help
Powered by ViewVC 1.0.3