source: javadoc/genius/core/boaframework/BOAcomponent.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0
File size: 16.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:56 CEST 2018 -->
6<title>BOAcomponent (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="BOAcomponent (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/BOAcomponent.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../genius/core/boaframework/BOAagentInfo.html" title="class in genius.core.boaframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/boaframework/BOAcomponent.html" target="_top">Frames</a></li>
57<li><a href="BOAcomponent.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.boaframework</div>
96<h2 title="Class BOAcomponent" class="title">Class BOAcomponent</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.boaframework.BOAcomponent</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd>java.io.Serializable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">BOAcomponent</span>
117extends java.lang.Object
118implements java.io.Serializable</pre>
119<div class="block">Creates a BOA component consisting of the classname of the component, the
120 type of the component, and all parameters. FIXME this creates nothing. It
121 seems just to contain info that can be used to createFrom a BOA component.</div>
122<dl>
123<dt><span class="seeLabel">See Also:</span></dt>
124<dd><a href="../../../serialized-form.html#genius.core.boaframework.BOAcomponent">Serialized Form</a></dd>
125</dl>
126</li>
127</ul>
128</div>
129<div class="summary">
130<ul class="blockList">
131<li class="blockList">
132<!-- ======== CONSTRUCTOR SUMMARY ======== -->
133<ul class="blockList">
134<li class="blockList"><a name="constructor.summary">
135<!-- -->
136</a>
137<h3>Constructor Summary</h3>
138<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
139<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
140<tr>
141<th class="colOne" scope="col">Constructor and Description</th>
142</tr>
143<tr class="altColor">
144<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#BOAcomponent-java.lang.String-genius.core.boaframework.BoaType-">BOAcomponent</a></span>(java.lang.String&nbsp;classname,
145 <a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;type)</code>
146<div class="block">Variant of the main constructor in which it is assumed that the component
147 has no parameters.</div>
148</td>
149</tr>
150<tr class="rowColor">
151<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#BOAcomponent-java.lang.String-genius.core.boaframework.BoaType-java.util.HashMap-">BOAcomponent</a></span>(java.lang.String&nbsp;classname,
152 <a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;type,
153 java.util.HashMap&lt;java.lang.String,java.lang.Double&gt;&nbsp;values)</code>
154<div class="block">Creates a BOA component consisting of the classname of the components,
155 the type, and the parameters with which the component should be loaded.</div>
156</td>
157</tr>
158</table>
159</li>
160</ul>
161<!-- ========== METHOD SUMMARY =========== -->
162<ul class="blockList">
163<li class="blockList"><a name="method.summary">
164<!-- -->
165</a>
166<h3>Method Summary</h3>
167<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
168<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
169<tr>
170<th class="colFirst" scope="col">Modifier and Type</th>
171<th class="colLast" scope="col">Method and Description</th>
172</tr>
173<tr id="i0" class="altColor">
174<td class="colFirst"><code>void</code></td>
175<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#addParameter-java.lang.String-java.lang.Double-">addParameter</a></span>(java.lang.String&nbsp;name,
176 java.lang.Double&nbsp;value)</code>
177<div class="block">Add a parameter to the set of parameters of this component.</div>
178</td>
179</tr>
180<tr id="i1" class="rowColor">
181<td class="colFirst"><code>java.lang.String</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#getClassname--">getClassname</a></span>()</code>&nbsp;</td>
183</tr>
184<tr id="i2" class="altColor">
185<td class="colFirst"><code>java.util.HashMap&lt;java.lang.String,java.lang.Double&gt;</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#getFullParameters--">getFullParameters</a></span>()</code>&nbsp;</td>
187</tr>
188<tr id="i3" class="rowColor">
189<td class="colFirst"><code>java.util.Set&lt;<a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a>&gt;</code></td>
190<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#getOriginalParameters--">getOriginalParameters</a></span>()</code>&nbsp;</td>
191</tr>
192<tr id="i4" class="altColor">
193<td class="colFirst"><code>java.util.HashMap&lt;java.lang.String,java.lang.Double&gt;</code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#getParameters--">getParameters</a></span>()</code>&nbsp;</td>
195</tr>
196<tr id="i5" class="rowColor">
197<td class="colFirst"><code><a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a></code></td>
198<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#getType--">getType</a></span>()</code>&nbsp;</td>
199</tr>
200<tr id="i6" class="altColor">
201<td class="colFirst"><code>java.lang.String</code></td>
202<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAcomponent.html#toString--">toString</a></span>()</code>&nbsp;</td>
203</tr>
204</table>
205<ul class="blockList">
206<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
207<!-- -->
208</a>
209<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
210<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
211</ul>
212</li>
213</ul>
214</li>
215</ul>
216</div>
217<div class="details">
218<ul class="blockList">
219<li class="blockList">
220<!-- ========= CONSTRUCTOR DETAIL ======== -->
221<ul class="blockList">
222<li class="blockList"><a name="constructor.detail">
223<!-- -->
224</a>
225<h3>Constructor Detail</h3>
226<a name="BOAcomponent-java.lang.String-genius.core.boaframework.BoaType-java.util.HashMap-">
227<!-- -->
228</a>
229<ul class="blockList">
230<li class="blockList">
231<h4>BOAcomponent</h4>
232<pre>public&nbsp;BOAcomponent(java.lang.String&nbsp;classname,
233 <a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;type,
234 java.util.HashMap&lt;java.lang.String,java.lang.Double&gt;&nbsp;values)</pre>
235<div class="block">Creates a BOA component consisting of the classname of the components,
236 the type, and the parameters with which the component should be loaded.</div>
237<dl>
238<dt><span class="paramLabel">Parameters:</span></dt>
239<dd><code>classname</code> - of the component. Note, this is not checked at all. We now
240 also accept absolute file path to a .class file.</dd>
241<dd><code>type</code> - of the component (for example bidding strategy).</dd>
242<dd><code>values</code> - parameters of the component.</dd>
243</dl>
244</li>
245</ul>
246<a name="BOAcomponent-java.lang.String-genius.core.boaframework.BoaType-">
247<!-- -->
248</a>
249<ul class="blockListLast">
250<li class="blockList">
251<h4>BOAcomponent</h4>
252<pre>public&nbsp;BOAcomponent(java.lang.String&nbsp;classname,
253 <a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;type)</pre>
254<div class="block">Variant of the main constructor in which it is assumed that the component
255 has no parameters.</div>
256<dl>
257<dt><span class="paramLabel">Parameters:</span></dt>
258<dd><code>classname</code> - of the component. Note, this is not checked at all. We now
259 also accept absolute file path to a .class file.</dd>
260<dd><code>type</code> - of the component (for example bidding strategy).</dd>
261</dl>
262</li>
263</ul>
264</li>
265</ul>
266<!-- ============ METHOD DETAIL ========== -->
267<ul class="blockList">
268<li class="blockList"><a name="method.detail">
269<!-- -->
270</a>
271<h3>Method Detail</h3>
272<a name="addParameter-java.lang.String-java.lang.Double-">
273<!-- -->
274</a>
275<ul class="blockList">
276<li class="blockList">
277<h4>addParameter</h4>
278<pre>public&nbsp;void&nbsp;addParameter(java.lang.String&nbsp;name,
279 java.lang.Double&nbsp;value)</pre>
280<div class="block">Add a parameter to the set of parameters of this component.</div>
281<dl>
282<dt><span class="paramLabel">Parameters:</span></dt>
283<dd><code>name</code> - of the parameter.</dd>
284<dd><code>value</code> - of the parameter.</dd>
285</dl>
286</li>
287</ul>
288<a name="getClassname--">
289<!-- -->
290</a>
291<ul class="blockList">
292<li class="blockList">
293<h4>getClassname</h4>
294<pre>public&nbsp;java.lang.String&nbsp;getClassname()</pre>
295<dl>
296<dt><span class="returnLabel">Returns:</span></dt>
297<dd>name of the class of the component.</dd>
298</dl>
299</li>
300</ul>
301<a name="getType--">
302<!-- -->
303</a>
304<ul class="blockList">
305<li class="blockList">
306<h4>getType</h4>
307<pre>public&nbsp;<a href="../../../genius/core/boaframework/BoaType.html" title="enum in genius.core.boaframework">BoaType</a>&nbsp;getType()</pre>
308<dl>
309<dt><span class="returnLabel">Returns:</span></dt>
310<dd>type of the component.</dd>
311</dl>
312</li>
313</ul>
314<a name="getParameters--">
315<!-- -->
316</a>
317<ul class="blockList">
318<li class="blockList">
319<h4>getParameters</h4>
320<pre>public&nbsp;java.util.HashMap&lt;java.lang.String,java.lang.Double&gt;&nbsp;getParameters()</pre>
321<dl>
322<dt><span class="returnLabel">Returns:</span></dt>
323<dd>parameters of the component.</dd>
324</dl>
325</li>
326</ul>
327<a name="getFullParameters--">
328<!-- -->
329</a>
330<ul class="blockList">
331<li class="blockList">
332<h4>getFullParameters</h4>
333<pre>public&nbsp;java.util.HashMap&lt;java.lang.String,java.lang.Double&gt;&nbsp;getFullParameters()</pre>
334<dl>
335<dt><span class="returnLabel">Returns:</span></dt>
336<dd>original parameters as specified in the GUI.</dd>
337</dl>
338</li>
339</ul>
340<a name="toString--">
341<!-- -->
342</a>
343<ul class="blockList">
344<li class="blockList">
345<h4>toString</h4>
346<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
347<dl>
348<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
349<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
350</dl>
351</li>
352</ul>
353<a name="getOriginalParameters--">
354<!-- -->
355</a>
356<ul class="blockListLast">
357<li class="blockList">
358<h4>getOriginalParameters</h4>
359<pre>public&nbsp;java.util.Set&lt;<a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a>&gt;&nbsp;getOriginalParameters()
360 throws <a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></pre>
361<dl>
362<dt><span class="returnLabel">Returns:</span></dt>
363<dd>the original parameters from (a temporary instance of) the actual
364 component.</dd>
365<dt><span class="throwsLabel">Throws:</span></dt>
366<dd><code><a href="../../../genius/core/exceptions/InstantiateException.html" title="class in genius.core.exceptions">InstantiateException</a></code> - if repitem can't be loaded</dd>
367</dl>
368</li>
369</ul>
370</li>
371</ul>
372</li>
373</ul>
374</div>
375</div>
376<!-- ========= END OF CLASS DATA ========= -->
377<!-- ======= START OF BOTTOM NAVBAR ====== -->
378<div class="bottomNav"><a name="navbar.bottom">
379<!-- -->
380</a>
381<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
382<a name="navbar.bottom.firstrow">
383<!-- -->
384</a>
385<ul class="navList" title="Navigation">
386<li><a href="../../../overview-summary.html">Overview</a></li>
387<li><a href="package-summary.html">Package</a></li>
388<li class="navBarCell1Rev">Class</li>
389<li><a href="class-use/BOAcomponent.html">Use</a></li>
390<li><a href="package-tree.html">Tree</a></li>
391<li><a href="../../../deprecated-list.html">Deprecated</a></li>
392<li><a href="../../../index-all.html">Index</a></li>
393<li><a href="../../../help-doc.html">Help</a></li>
394</ul>
395</div>
396<div class="subNav">
397<ul class="navList">
398<li><a href="../../../genius/core/boaframework/BOAagentInfo.html" title="class in genius.core.boaframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
399<li><a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
400</ul>
401<ul class="navList">
402<li><a href="../../../index.html?genius/core/boaframework/BOAcomponent.html" target="_top">Frames</a></li>
403<li><a href="BOAcomponent.html" target="_top">No&nbsp;Frames</a></li>
404</ul>
405<ul class="navList" id="allclasses_navbar_bottom">
406<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
407</ul>
408<div>
409<script type="text/javascript"><!--
410 allClassesLink = document.getElementById("allclasses_navbar_bottom");
411 if(window==top) {
412 allClassesLink.style.display = "block";
413 }
414 else {
415 allClassesLink.style.display = "none";
416 }
417 //-->
418</script>
419</div>
420<div>
421<ul class="subNavList">
422<li>Summary:&nbsp;</li>
423<li>Nested&nbsp;|&nbsp;</li>
424<li>Field&nbsp;|&nbsp;</li>
425<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
426<li><a href="#method.summary">Method</a></li>
427</ul>
428<ul class="subNavList">
429<li>Detail:&nbsp;</li>
430<li>Field&nbsp;|&nbsp;</li>
431<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
432<li><a href="#method.detail">Method</a></li>
433</ul>
434</div>
435<a name="skip.navbar.bottom">
436<!-- -->
437</a></div>
438<!-- ======== END OF BOTTOM NAVBAR ======= -->
439</body>
440</html>
Note: See TracBrowser for help on using the repository browser.