| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| |
| <!-- Generated by javadoc (1.8.0_172) on Tue Nov 06 08:20:12 CET 2018 --> |
| <title>AmaltheaIndex</title> |
| <meta name="date" content="2018-11-06"> |
| |
| <link rel="stylesheet" type="text/css" href="index.css" title="Style"> |
| </head> |
| |
| <body> |
| |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.app4mc.amalthea.model</div> |
| <h2 title="Class AmaltheaIndex" class="title">Class AmaltheaIndex</h2> |
| </div> |
| <div class="contentContainer"> |
| |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <div class="block">This class provides static methods for efficient model navigation, search and delete. |
| <p> |
| An <code>AmaltheaCrossReferenceAdapter</code> is created and attached to the root context of the model. |
| The adapter maintains an index that allows fast access to inverse references and an index based on object name. |
| <p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" summary="Method Summary table, listing methods, and an explanation" cellspacing="0" cellpadding="3" border="0"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="#delete-EObject-">delete</a></span>(EObject eObject)</code> |
| <div class="block">Deletes the object from its <code>containing</code> resource |
| and/or its <code>containing</code> object as well as from any |
| other feature that references it within the enclosing root context |
| (resource set, resource or root object).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="#deleteAll-Collection-">deleteAll</a></span>(Collection<? extends EObject> eObjects)</code> |
| <div class="block">Deletes the objects from their <code>containing</code> resource |
| and/or their <code>containing</code> object as well as from any |
| other feature that references it within the enclosing root context |
| (resource set, resource or root object).</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="#deleteAll-Collection-boolean-">deleteAll</a></span>(Collection<? extends EObject> eObjects, boolean recursive)</code> |
| <div class="block">Deletes the objects from their <code>containing</code> resource |
| and/or their <code>containing</code> object as well as from any |
| other feature that references it within the enclosing root context |
| (resource set, resource or root object).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T extends INamed><br>Set<? extends T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="#getElements-Notifier-Pattern-Class-">getElements</a></span>(Notifier context, Pattern namePattern, Class<T> targetClass)</code> |
| <div class="block">Finds elements by name pattern and class</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <T extends INamed><br>Set<? extends T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="#getElements-Notifier-String-Class-">getElements</a></span>(Notifier context, String name, Class<T> targetClass)</code> |
| <div class="block">Finds elements by name and class</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="delete-EObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>public static void delete(EObject eObject)</pre> |
| <div class="block">Deletes the object from its <code>containing</code> resource |
| and/or its <code>containing</code> object as well as from any |
| other feature that references it within the enclosing root context |
| (resource set, resource or root object). Contained children of the object |
| are similarly removed from any features that reference them.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eObject</code> - object to delete</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAll-Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>public static void deleteAll(Collection<? extends EObject> eObjects)</pre> |
| <div class="block">Deletes the objects from their <code>containing</code> resource |
| and/or their <code>containing</code> object as well as from any |
| other feature that references it within the enclosing root context |
| (resource set, resource or root object). Contained children of the object |
| are similarly removed from any features that reference them.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eObjects</code> - objects to delete</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAll-Collection-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>public static void deleteAll(Collection<? extends EObject> eObjects, boolean recursive)</pre> |
| <div class="block">Deletes the objects from their <code>containing</code> resource |
| and/or their <code>containing</code> object as well as from any |
| other feature that references it within the enclosing root context |
| (resource set, resource or root object). |
| If recursive is true, contained children of the object are similarly removed |
| from any features that reference them.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eObjects</code> - objects to delete</dd> |
| <dd><code>recursive</code> - true: contained children should also be deleted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getElements-Notifier-String-Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getElements</h4> |
| <pre>public static <T extends INamed> Set<? extends T> getElements(Notifier context, String name, Class<T> targetClass)</pre> |
| <div class="block">Finds elements by name and class</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - EObject, Resource or ResourceSet</dd> |
| <dd><code>name</code> - String</dd> |
| <dd><code>targetClass</code> - for example: <code>Label.class</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Set of named objects (IName)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getElements-Notifier-Pattern-Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getElements</h4> |
| <pre>public static <T extends INamed> Set<? extends T> getElements(Notifier context, Pattern namePattern, Class<T> targetClass)</pre> |
| <div class="block">Finds elements by name pattern and class</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - EObject, Resource or ResourceSet</dd> |
| <dd><code>namePattern</code> - for example: <code>Pattern.compile("Prefix_.*")</code></dd> |
| <dd><code>targetClass</code> - for example: <code>Label.class</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Set of named objects (IName)</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| |
| </body> |
| </html> |