| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_75) on Mon May 18 03:56:40 EDT 2015 --> |
| <title>EObjectIndex (EMF Compare API Specification)</title> |
| <meta name="date" content="2015-05-18"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EObjectIndex (EMF Compare API Specification)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/EObjectIndex.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><span style='font-size:small'><b>EMF Compare</b><br>3.2.0.201505180755</span></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EditionDistance.Builder.html" title="class in org.eclipse.emf.compare.match.eobject"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/emf/compare/match/eobject/EObjectIndex.html" target="_top">Frames</a></li> |
| <li><a href="EObjectIndex.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.emf.compare.match.eobject</div> |
| <h2 title="Interface EObjectIndex" class="title">Interface EObjectIndex</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/eclipse/emf/compare/match/eobject/internal/ByTypeIndex.html" title="class in org.eclipse.emf.compare.match.eobject.internal">ByTypeIndex</a>, <a href="../../../../../../org/eclipse/emf/compare/match/eobject/internal/ProximityIndex.html" title="class in org.eclipse.emf.compare.match.eobject.internal">ProximityIndex</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">EObjectIndex</span></pre> |
| <div class="block">An EObjectIndex has for responsability to store/remove EObjects and return the closest EObject from another |
| one (each one being registered with a different Side.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a></strong></code> |
| <div class="block">An enumeration used in the API to specify sides.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a>,<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.html#findClosests(org.eclipse.emf.compare.Comparison,%20org.eclipse.emf.ecore.EObject,%20org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)">findClosests</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/Comparison.html" title="interface in org.eclipse.emf.compare">Comparison</a> inProgress, |
| <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a> eObj, |
| <a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</code> |
| <div class="block">Return the closest EObjects found in other sides than the one given.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.html#getValuesStillThere(org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)">getValuesStillThere</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</code> |
| <div class="block">return the list of EObjects of a given side still available in the index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.html#index(org.eclipse.emf.ecore.EObject,%20org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)">index</a></strong>(<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a> eObj, |
| <a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</code> |
| <div class="block">Register an Object in the index with the given side.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.html#remove(org.eclipse.emf.ecore.EObject,%20org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)">remove</a></strong>(<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a> eObj, |
| <a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</code> |
| <div class="block">Remove an object from the index.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getValuesStillThere(org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValuesStillThere</h4> |
| <pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>> getValuesStillThere(<a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</pre> |
| <div class="block">return the list of EObjects of a given side still available in the index.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>side</code> - the side we are looking for.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the list of EObjects of a given side still available in the index.</dd></dl> |
| </li> |
| </ul> |
| <a name="findClosests(org.eclipse.emf.compare.Comparison, org.eclipse.emf.ecore.EObject, org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findClosests</h4> |
| <pre><a href="http://download.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a>,<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>> findClosests(<a href="../../../../../../org/eclipse/emf/compare/Comparison.html" title="interface in org.eclipse.emf.compare">Comparison</a> inProgress, |
| <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a> eObj, |
| <a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</pre> |
| <div class="block">Return the closest EObjects found in other sides than the one given.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inProgress</code> - the comparison currently being computed. It will not be changed directly but only queried to |
| know if some element has already been matched or not.</dd><dd><code>eObj</code> - the base EObject used to lookup similar ones.</dd><dd><code>side</code> - the side of the passed EObject.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a map of Side, EObjects, returning all the found objects (and the passed one) which are the |
| closests.</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(org.eclipse.emf.ecore.EObject, org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>void remove(<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a> eObj, |
| <a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</pre> |
| <div class="block">Remove an object from the index.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>eObj</code> - object to remove.</dd><dd><code>side</code> - Side in which this object was.</dd></dl> |
| </li> |
| </ul> |
| <a name="index(org.eclipse.emf.ecore.EObject, org.eclipse.emf.compare.match.eobject.EObjectIndex.Side)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>index</h4> |
| <pre>void index(<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a> eObj, |
| <a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject">EObjectIndex.Side</a> side)</pre> |
| <div class="block">Register an Object in the index with the given side.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>eObj</code> - the <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore"><code>EObject</code></a> to register.</dd><dd><code>side</code> - the side in which it should be registered.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/EObjectIndex.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><span style='font-size:small'><b>EMF Compare</b><br>3.2.0.201505180755</span></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EditionDistance.Builder.html" title="class in org.eclipse.emf.compare.match.eobject"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/emf/compare/match/eobject/EObjectIndex.Side.html" title="enum in org.eclipse.emf.compare.match.eobject"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/emf/compare/match/eobject/EObjectIndex.html" target="_top">Frames</a></li> |
| <li><a href="EObjectIndex.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><br><span style='font-size:small;float:right'>Copyright (c) 2006, 2014 Obeo and others. All rights reserved.</span></small></p> |
| </body> |
| </html> |
