source: javadoc/genius/core/utility/DataObjects.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: 12.5 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:58 CEST 2018 -->
6<title>DataObjects (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="DataObjects (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":9,"i1":10,"i2":10,"i3":10};
22var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/DataObjects.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/utility/ConstraintUtilitySpace.html" title="class in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/utility/EVALFUNCTYPE.html" title="enum in genius.core.utility"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/utility/DataObjects.html" target="_top">Frames</a></li>
57<li><a href="DataObjects.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>Constr&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>Constr&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.utility</div>
96<h2 title="Class DataObjects" class="title">Class DataObjects</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.utility.DataObjects</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<hr>
111<br>
112<pre>public class <span class="typeNameLabel">DataObjects</span>
113extends java.lang.Object</pre>
114<div class="block">This class handles saving and loading data for agents which are negotiating
115 in a specific preference profile. Every unique combination of an agent class
116 name and a preference profile name will be saved in a different file; for
117 identification.
118
119 This is here to support the old <a href="../../../genius/core/Agent.html" title="class in genius.core"><code>Agent</code></a>. The files are just available
120 in the file system and therefore agents can read each other's data. Therefore
121 it is recommended that this is not used for new developments.</div>
122</li>
123</ul>
124</div>
125<div class="summary">
126<ul class="blockList">
127<li class="blockList">
128<!-- ========== METHOD SUMMARY =========== -->
129<ul class="blockList">
130<li class="blockList"><a name="method.summary">
131<!-- -->
132</a>
133<h3>Method Summary</h3>
134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
135<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
136<tr>
137<th class="colFirst" scope="col">Modifier and Type</th>
138<th class="colLast" scope="col">Method and Description</th>
139</tr>
140<tr id="i0" class="altColor">
141<td class="colFirst"><code>static <a href="../../../genius/core/utility/DataObjects.html" title="class in genius.core.utility">DataObjects</a></code></td>
142<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/DataObjects.html#getInstance--">getInstance</a></span>()</code>&nbsp;</td>
143</tr>
144<tr id="i1" class="rowColor">
145<td class="colFirst"><code>java.io.Serializable</code></td>
146<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/DataObjects.html#loadData-java.lang.String-java.lang.String-">loadData</a></span>(java.lang.String&nbsp;agentClassName,
147 java.lang.String&nbsp;prefProfName)</code>
148<div class="block">Loads the data of the agent, by the agentClassName and the prefProfName.</div>
149</td>
150</tr>
151<tr id="i2" class="altColor">
152<td class="colFirst"><code>boolean</code></td>
153<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/DataObjects.html#restartFolder--">restartFolder</a></span>()</code>
154<div class="block">Restarts the folder "theFolder", meaning it deletes all files in it and
155 then creates a new empty folder with the same name.</div>
156</td>
157</tr>
158<tr id="i3" class="rowColor">
159<td class="colFirst"><code>boolean</code></td>
160<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/DataObjects.html#saveData-java.io.Serializable-java.lang.String-java.lang.String-">saveData</a></span>(java.io.Serializable&nbsp;dataToSave,
161 java.lang.String&nbsp;agentClassName,
162 java.lang.String&nbsp;prefProfName)</code>
163<div class="block">Saves dataToSave of the agent with class agentClassName for a preference
164 profile prefProfName.</div>
165</td>
166</tr>
167</table>
168<ul class="blockList">
169<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
170<!-- -->
171</a>
172<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
173<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
174</ul>
175</li>
176</ul>
177</li>
178</ul>
179</div>
180<div class="details">
181<ul class="blockList">
182<li class="blockList">
183<!-- ============ METHOD DETAIL ========== -->
184<ul class="blockList">
185<li class="blockList"><a name="method.detail">
186<!-- -->
187</a>
188<h3>Method Detail</h3>
189<a name="getInstance--">
190<!-- -->
191</a>
192<ul class="blockList">
193<li class="blockList">
194<h4>getInstance</h4>
195<pre>public static&nbsp;<a href="../../../genius/core/utility/DataObjects.html" title="class in genius.core.utility">DataObjects</a>&nbsp;getInstance()</pre>
196</li>
197</ul>
198<a name="restartFolder--">
199<!-- -->
200</a>
201<ul class="blockList">
202<li class="blockList">
203<h4>restartFolder</h4>
204<pre>public&nbsp;boolean&nbsp;restartFolder()</pre>
205<div class="block">Restarts the folder "theFolder", meaning it deletes all files in it and
206 then creates a new empty folder with the same name.</div>
207<dl>
208<dt><span class="returnLabel">Returns:</span></dt>
209<dd>true if succeeded</dd>
210</dl>
211</li>
212</ul>
213<a name="saveData-java.io.Serializable-java.lang.String-java.lang.String-">
214<!-- -->
215</a>
216<ul class="blockList">
217<li class="blockList">
218<h4>saveData</h4>
219<pre>public&nbsp;boolean&nbsp;saveData(java.io.Serializable&nbsp;dataToSave,
220 java.lang.String&nbsp;agentClassName,
221 java.lang.String&nbsp;prefProfName)</pre>
222<div class="block">Saves dataToSave of the agent with class agentClassName for a preference
223 profile prefProfName. It creates a unique name (concatenating the agent
224 class name and the preference profile file name) to be the name of the
225 file which will contain dataToSave.</div>
226<dl>
227<dt><span class="paramLabel">Parameters:</span></dt>
228<dd><code>dataToSave</code> - a <code>Serializable</code> object to save</dd>
229<dd><code>agentClassName</code> - is the class name of the agent who wants to save the data</dd>
230<dd><code>prefProfName</code> - is the preference profile for which the agent wants to save
231 data</dd>
232<dt><span class="returnLabel">Returns:</span></dt>
233<dd>true if dataToSave was saved successfully false otherwise.</dd>
234</dl>
235</li>
236</ul>
237<a name="loadData-java.lang.String-java.lang.String-">
238<!-- -->
239</a>
240<ul class="blockListLast">
241<li class="blockList">
242<h4>loadData</h4>
243<pre>public&nbsp;java.io.Serializable&nbsp;loadData(java.lang.String&nbsp;agentClassName,
244 java.lang.String&nbsp;prefProfName)</pre>
245<div class="block">Loads the data of the agent, by the agentClassName and the prefProfName.
246 It identifies the data by a unique name (concatenating the agent class
247 name and the preference profile file name) which is the name of the file
248 containing the data.</div>
249<dl>
250<dt><span class="paramLabel">Parameters:</span></dt>
251<dd><code>agentClassName</code> - is the class name of the agent who wants to load the data</dd>
252<dd><code>prefProfName</code> - is the preference profile for which the agent wants to load
253 the data</dd>
254<dt><span class="returnLabel">Returns:</span></dt>
255<dd>the data that was saved by the agent when he was in the role of
256 the preference profile filename.</dd>
257</dl>
258</li>
259</ul>
260</li>
261</ul>
262</li>
263</ul>
264</div>
265</div>
266<!-- ========= END OF CLASS DATA ========= -->
267<!-- ======= START OF BOTTOM NAVBAR ====== -->
268<div class="bottomNav"><a name="navbar.bottom">
269<!-- -->
270</a>
271<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
272<a name="navbar.bottom.firstrow">
273<!-- -->
274</a>
275<ul class="navList" title="Navigation">
276<li><a href="../../../overview-summary.html">Overview</a></li>
277<li><a href="package-summary.html">Package</a></li>
278<li class="navBarCell1Rev">Class</li>
279<li><a href="class-use/DataObjects.html">Use</a></li>
280<li><a href="package-tree.html">Tree</a></li>
281<li><a href="../../../deprecated-list.html">Deprecated</a></li>
282<li><a href="../../../index-all.html">Index</a></li>
283<li><a href="../../../help-doc.html">Help</a></li>
284</ul>
285</div>
286<div class="subNav">
287<ul class="navList">
288<li><a href="../../../genius/core/utility/ConstraintUtilitySpace.html" title="class in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
289<li><a href="../../../genius/core/utility/EVALFUNCTYPE.html" title="enum in genius.core.utility"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
290</ul>
291<ul class="navList">
292<li><a href="../../../index.html?genius/core/utility/DataObjects.html" target="_top">Frames</a></li>
293<li><a href="DataObjects.html" target="_top">No&nbsp;Frames</a></li>
294</ul>
295<ul class="navList" id="allclasses_navbar_bottom">
296<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
297</ul>
298<div>
299<script type="text/javascript"><!--
300 allClassesLink = document.getElementById("allclasses_navbar_bottom");
301 if(window==top) {
302 allClassesLink.style.display = "block";
303 }
304 else {
305 allClassesLink.style.display = "none";
306 }
307 //-->
308</script>
309</div>
310<div>
311<ul class="subNavList">
312<li>Summary:&nbsp;</li>
313<li>Nested&nbsp;|&nbsp;</li>
314<li>Field&nbsp;|&nbsp;</li>
315<li>Constr&nbsp;|&nbsp;</li>
316<li><a href="#method.summary">Method</a></li>
317</ul>
318<ul class="subNavList">
319<li>Detail:&nbsp;</li>
320<li>Field&nbsp;|&nbsp;</li>
321<li>Constr&nbsp;|&nbsp;</li>
322<li><a href="#method.detail">Method</a></li>
323</ul>
324</div>
325<a name="skip.navbar.bottom">
326<!-- -->
327</a></div>
328<!-- ======== END OF BOTTOM NAVBAR ======= -->
329</body>
330</html>
Note: See TracBrowser for help on using the repository browser.