Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: b31b767abddc8cf597d6f102271654208fe4ec96 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_191) on Mon Jan 28 10:50:16 CET 2019 -->
<title>AmaltheaIndex</title>
<meta name="date" content="2019-01-28">
<link rel="stylesheet" type="text/css" href="../stylesheet.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">
<ul class="inheritance">
<li>Object</li>
<li>
<ul class="inheritance">
<li>AmaltheaIndex</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">AmaltheaIndex</span>
extends Object</pre>
<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>
 The method <a href="#getInverseReferences-org.eclipse.emf.ecore.EObject-org.eclipse.emf.ecore.EReference-java.util.Set-"><code>getInverseReferences</code></a> is called from several
 generated model objects to compute inverse transient references based on the incoming references.</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" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</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-org.eclipse.emf.ecore.EObject-">delete</a></span>(EObject&nbsp;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-java.util.Collection-">deleteAll</a></span>(Collection&lt;? extends EObject&gt;&nbsp;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-java.util.Collection-boolean-">deleteAll</a></span>(Collection&lt;? extends EObject&gt;&nbsp;eObjects,
         boolean&nbsp;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 &lt;T extends INamed&gt;<br>Set&lt;? extends T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="#getElements-org.eclipse.emf.common.notify.Notifier-java.util.regex.Pattern-java.lang.Class-">getElements</a></span>(Notifier&nbsp;context,
           Pattern&nbsp;namePattern,
           Class&lt;T&gt;&nbsp;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 &lt;T extends INamed&gt;<br>Set&lt;? extends T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="#getElements-org.eclipse.emf.common.notify.Notifier-java.lang.String-java.lang.Class-">getElements</a></span>(Notifier&nbsp;context,
           String&nbsp;name,
           Class&lt;T&gt;&nbsp;targetClass)</code>
<div class="block">Finds elements by name and class</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;EList&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="#getInverseReferences-org.eclipse.emf.ecore.EObject-org.eclipse.emf.ecore.EReference-java.util.Set-">getInverseReferences</a></span>(EObject&nbsp;eObject,
                    EReference&nbsp;resultEReference,
                    Set&lt;EReference&gt;&nbsp;targetEReferences)</code>
<div class="block">Computes a list of objects that refer to an EObject via dedicated references.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="getInverseReferences-org.eclipse.emf.ecore.EObject-org.eclipse.emf.ecore.EReference-java.util.Set-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInverseReferences</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;EList&lt;T&gt;&nbsp;getInverseReferences(EObject&nbsp;eObject,
                                                EReference&nbsp;resultEReference,
                                                Set&lt;EReference&gt;&nbsp;targetEReferences)</pre>
<div class="block">Computes a list of objects that refer to an EObject via dedicated references.
 <p>
 This method is called from several generated model objects to compute
 an inverse transient reference based on the incoming references.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>eObject</code> - object that implements a derived transient opposite reference</dd>
<dd><code>resultEReference</code> - opposite reference definition (resulting objects are computed)</dd>
<dd><code>targetEReferences</code> - list of incoming references</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>EcoreEList.UnmodifiableEList &lt;T&gt;</dd>
</dl>
</li>
</ul>
<a name="delete-org.eclipse.emf.ecore.EObject-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre>public static&nbsp;void&nbsp;delete(EObject&nbsp;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-java.util.Collection-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre>public static&nbsp;void&nbsp;deleteAll(Collection&lt;? extends EObject&gt;&nbsp;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-java.util.Collection-boolean-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre>public static&nbsp;void&nbsp;deleteAll(Collection&lt;? extends EObject&gt;&nbsp;eObjects,
                             boolean&nbsp;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-org.eclipse.emf.common.notify.Notifier-java.lang.String-java.lang.Class-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElements</h4>
<pre>public static&nbsp;&lt;T extends INamed&gt;&nbsp;Set&lt;? extends T&gt;&nbsp;getElements(Notifier&nbsp;context,
                                                              String&nbsp;name,
                                                              Class&lt;T&gt;&nbsp;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-org.eclipse.emf.common.notify.Notifier-java.util.regex.Pattern-java.lang.Class-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getElements</h4>
<pre>public static&nbsp;&lt;T extends INamed&gt;&nbsp;Set&lt;? extends T&gt;&nbsp;getElements(Notifier&nbsp;context,
                                                              Pattern&nbsp;namePattern,
                                                              Class&lt;T&gt;&nbsp;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>

Back to the top