blob: e8cdeec8b2ef9ab68f615bd83a8a2c5a86b31cea [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<!-- Generated by javadoc (1.8.0_152) on Tue Jan 30 10:25:33 CET 2018 -->
<title>ModelDynamicCacheBuilder</title>
<meta name="date" content="2018-01-30">
<link media="all" href="index.css" type="text/css" rel="stylesheet">
</head>
<body>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h2 title="Class ModelDynamicCacheBuilder" class="title">Class ModelDynamicCacheBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<div class="block">This class is used to build the cache of the entire EMF model and fetch the elements accordingly. <br>
This approach improves the performance of fetching the model elements based on name. In case there are modifications in the model data, cache is automatically updated (which could cost additional performance for rebuilding it)
<b>Note:</b>: Cache will be updated (on each model change) --&gt; lazily on the first access of the getter methods after the EMF model change.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation" cellspacing="0" cellpadding="3" border="0">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tbody><tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="#">ModelDynamicCacheBuilder</a></span>(Amalthea&nbsp;root)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="#">ModelDynamicCacheBuilder</a></span>(org.eclipse.emf.ecore.resource.ResourceSet&nbsp;resourceSet)</code>&nbsp;</td>
</tr>
</tbody></table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span class="tabEnd">&nbsp;</span></span></caption>
<tbody><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>&lt;T&gt;&nbsp;List&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="#">getElementsBasedOnName</a></span>(String&nbsp;name,
Class&lt;T&gt;&nbsp;targetClass)</code>
<div class="block">This method is used to get the Amalthea model elements based on the supplied name and targetClass parameters</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>&lt;T extends org.eclipse.emf.ecore.EObject&gt;<br>List&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="#">getElementsBasedOnRegex</a></span>(String&nbsp;regexForName,
Class&lt;T&gt;&nbsp;targetClass)</code>
<div class="block">This method is used to get the Amalthea model elements based on the
supplied regex for name and targetClass parameters</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;List&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="#">getElementsBasedOnType</a></span>(Class&lt;T&gt;&nbsp;targetClass)</code>
<div class="block">This method is used to get the Amalthea model elements based on the
supplied targetClass parameter</div>
</td>
</tr>
</tbody></table>
<ul class="blockList">
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getElementsBasedOnName-String-Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementsBasedOnName</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;List&lt;T&gt;&nbsp;getElementsBasedOnName(String&nbsp;name,Class&lt;T&gt;&nbsp;targetClass)</pre>
<div class="block">This method is used to get the Amalthea model elements based on the supplied name and targetClass parameters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - String. name of the Amalthea model element (e.g: Label name)</dd>
<dd><code>targetClass</code> - Class of the Amalthea model element (e.g: Label, Runnable, Task, ISR etc.,)
<br> <i><u>Note</u></i> : Supplied "Class" should be concrete class, for which EObject is created. <br><i>Super class/Interface/Abstract classes are not supported</i></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List<eobject> matching eObjects from Amalthea model</eobject></dd>
</dl>
</li>
</ul>
<a name="getElementsBasedOnRegex-String-Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementsBasedOnRegex</h4>
<pre>public&nbsp;&lt;T extends org.eclipse.emf.ecore.EObject&gt;&nbsp;List&lt;T&gt;&nbsp;getElementsBasedOnRegex(String&nbsp;regexForName,Class&lt;T&gt;&nbsp;targetClass)</pre>
<div class="block">This method is used to get the Amalthea model elements based on the
supplied regex for name and targetClass parameters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>regexForName</code> - String. name regex of the Amalthea model element (e.g: Label
name regex : .*_msg)</dd>
<dd><code>targetClass</code> - Class of the Amalthea model element (e.g: Label, Runnable,
Task, ISR etc.,) <br>
<i><u>Note</u></i> : Supplied "Class" should be concrete
class, for which EObject is created. <br>
<i>Super class/Interface/Abstract classes are not
supported</i></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List<eobject> matching eObjects from Amalthea model</eobject></dd>
</dl>
</li>
</ul>
<a name="getElementsBasedOnType-Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getElementsBasedOnType</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;List&lt;T&gt;&nbsp;getElementsBasedOnType(Class&lt;T&gt;&nbsp;targetClass)</pre>
<div class="block">This method is used to get the Amalthea model elements based on the
supplied targetClass parameter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetClass</code> - Class of the Amalthea model element (e.g: Label, Runnable,
Task, ISR etc.,) <br>
<i><u>Note</u></i> : Supplied "Class" should be concrete
class, for which EObject is created. <br>
<i>Super class/Interface/Abstract classes are not
supported</i></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List<eobject> matching eObjects from Amalthea model</eobject></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</body>
</html>