source: javadoc/genius/core/logging/StatisticsLogger.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: 14.4 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:57 CEST 2018 -->
6<title>StatisticsLogger (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="StatisticsLogger (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":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/StatisticsLogger.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/logging/FileLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/logging/XmlLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/logging/StatisticsLogger.html" target="_top">Frames</a></li>
57<li><a href="StatisticsLogger.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.logging</div>
96<h2 title="Class StatisticsLogger" class="title">Class StatisticsLogger</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.logging.StatisticsLogger</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><a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.io.Closeable, java.lang.AutoCloseable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">StatisticsLogger</span>
117extends java.lang.Object
118implements <a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.io.Closeable</pre>
119<div class="block">Keeps track of tournament and creates statistic information.</div>
120</li>
121</ul>
122</div>
123<div class="summary">
124<ul class="blockList">
125<li class="blockList">
126<!-- =========== FIELD SUMMARY =========== -->
127<ul class="blockList">
128<li class="blockList"><a name="field.summary">
129<!-- -->
130</a>
131<h3>Field Summary</h3>
132<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
133<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
134<tr>
135<th class="colFirst" scope="col">Modifier and Type</th>
136<th class="colLast" scope="col">Field and Description</th>
137</tr>
138<tr class="altColor">
139<td class="colFirst"><code>protected <a href="../../../genius/core/logging/AgentsStatistics.html" title="class in genius.core.logging">AgentsStatistics</a></code></td>
140<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/StatisticsLogger.html#agentStats">agentStats</a></span></code>
141<div class="block">key= agent name, Statistic is the statistical info logged for that agent.</div>
142</td>
143</tr>
144</table>
145</li>
146</ul>
147<!-- ======== CONSTRUCTOR SUMMARY ======== -->
148<ul class="blockList">
149<li class="blockList"><a name="constructor.summary">
150<!-- -->
151</a>
152<h3>Constructor Summary</h3>
153<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
154<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
155<tr>
156<th class="colOne" scope="col">Constructor and Description</th>
157</tr>
158<tr class="altColor">
159<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/logging/StatisticsLogger.html#StatisticsLogger-java.io.OutputStream-">StatisticsLogger</a></span>(java.io.OutputStream&nbsp;out)</code>&nbsp;</td>
160</tr>
161</table>
162</li>
163</ul>
164<!-- ========== METHOD SUMMARY =========== -->
165<ul class="blockList">
166<li class="blockList"><a name="method.summary">
167<!-- -->
168</a>
169<h3>Method Summary</h3>
170<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
171<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>
172<tr>
173<th class="colFirst" scope="col">Modifier and Type</th>
174<th class="colLast" scope="col">Method and Description</th>
175</tr>
176<tr id="i0" class="altColor">
177<td class="colFirst"><code>void</code></td>
178<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/StatisticsLogger.html#close--">close</a></span>()</code>&nbsp;</td>
179</tr>
180<tr id="i1" class="rowColor">
181<td class="colFirst"><code>void</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/StatisticsLogger.html#notifyChange-genius.core.events.NegotiationEvent-">notifyChange</a></span>(<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&nbsp;e)</code>
183<div class="block">a notification call that occurs when something changed.</div>
184</td>
185</tr>
186</table>
187<ul class="blockList">
188<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
189<!-- -->
190</a>
191<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
192<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
193</ul>
194</li>
195</ul>
196</li>
197</ul>
198</div>
199<div class="details">
200<ul class="blockList">
201<li class="blockList">
202<!-- ============ FIELD DETAIL =========== -->
203<ul class="blockList">
204<li class="blockList"><a name="field.detail">
205<!-- -->
206</a>
207<h3>Field Detail</h3>
208<a name="agentStats">
209<!-- -->
210</a>
211<ul class="blockListLast">
212<li class="blockList">
213<h4>agentStats</h4>
214<pre>protected&nbsp;<a href="../../../genius/core/logging/AgentsStatistics.html" title="class in genius.core.logging">AgentsStatistics</a> agentStats</pre>
215<div class="block">key= agent name, Statistic is the statistical info logged for that agent.</div>
216</li>
217</ul>
218</li>
219</ul>
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="StatisticsLogger-java.io.OutputStream-">
227<!-- -->
228</a>
229<ul class="blockListLast">
230<li class="blockList">
231<h4>StatisticsLogger</h4>
232<pre>public&nbsp;StatisticsLogger(java.io.OutputStream&nbsp;out)
233 throws java.io.FileNotFoundException,
234 javax.xml.stream.XMLStreamException</pre>
235<dl>
236<dt><span class="paramLabel">Parameters:</span></dt>
237<dd><code>out</code> - <code>OutputStream</code> to write the log to. If this is a file,
238 we recommend to use the extension ".xml". This logger becomes
239 owner of this outputstream and will close it eventually.</dd>
240<dt><span class="throwsLabel">Throws:</span></dt>
241<dd><code>java.io.FileNotFoundException</code></dd>
242<dd><code>javax.xml.stream.XMLStreamException</code></dd>
243</dl>
244</li>
245</ul>
246</li>
247</ul>
248<!-- ============ METHOD DETAIL ========== -->
249<ul class="blockList">
250<li class="blockList"><a name="method.detail">
251<!-- -->
252</a>
253<h3>Method Detail</h3>
254<a name="close--">
255<!-- -->
256</a>
257<ul class="blockList">
258<li class="blockList">
259<h4>close</h4>
260<pre>public&nbsp;void&nbsp;close()</pre>
261<dl>
262<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
263<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
264<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
265<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
266</dl>
267</li>
268</ul>
269<a name="notifyChange-genius.core.events.NegotiationEvent-">
270<!-- -->
271</a>
272<ul class="blockListLast">
273<li class="blockList">
274<h4>notifyChange</h4>
275<pre>public&nbsp;void&nbsp;notifyChange(<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&nbsp;e)</pre>
276<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/listener/Listener.html#notifyChange-T-">Listener</a></code></span></div>
277<div class="block">a notification call that occurs when something changed. Consult the
278 parent object for details about this event.
279
280 <h1>NOTICE 1</h1> notifications run in the thread of the caller. The
281 caller will be blocked until this callback has been completed. It is
282 therfore good practice to handle callbacks quickly.
283
284 <h1>NOTICE 2</h1> Notifications often cross a thread sarety boundary. For
285 example when in MVC a model (typically thread safe) calls back a panel
286 (not thread safe). The called side (the panel) thus must handle the
287 callback in a thread safe manner, e.g. using
288 <code>SwingUtilities.invokeLater(Runnable)</code>. We recommend to avoid
289 synchronize as this will can block indefinitely (see notice 1) which
290 might lead to deadlocks.</div>
291<dl>
292<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
293<dd><code><a href="../../../genius/core/listener/Listener.html#notifyChange-T-">notifyChange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;</code></dd>
294<dt><span class="paramLabel">Parameters:</span></dt>
295<dd><code>e</code> - additional data, typically the new value associated with the
296 event</dd>
297</dl>
298</li>
299</ul>
300</li>
301</ul>
302</li>
303</ul>
304</div>
305</div>
306<!-- ========= END OF CLASS DATA ========= -->
307<!-- ======= START OF BOTTOM NAVBAR ====== -->
308<div class="bottomNav"><a name="navbar.bottom">
309<!-- -->
310</a>
311<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
312<a name="navbar.bottom.firstrow">
313<!-- -->
314</a>
315<ul class="navList" title="Navigation">
316<li><a href="../../../overview-summary.html">Overview</a></li>
317<li><a href="package-summary.html">Package</a></li>
318<li class="navBarCell1Rev">Class</li>
319<li><a href="class-use/StatisticsLogger.html">Use</a></li>
320<li><a href="package-tree.html">Tree</a></li>
321<li><a href="../../../deprecated-list.html">Deprecated</a></li>
322<li><a href="../../../index-all.html">Index</a></li>
323<li><a href="../../../help-doc.html">Help</a></li>
324</ul>
325</div>
326<div class="subNav">
327<ul class="navList">
328<li><a href="../../../genius/core/logging/FileLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
329<li><a href="../../../genius/core/logging/XmlLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
330</ul>
331<ul class="navList">
332<li><a href="../../../index.html?genius/core/logging/StatisticsLogger.html" target="_top">Frames</a></li>
333<li><a href="StatisticsLogger.html" target="_top">No&nbsp;Frames</a></li>
334</ul>
335<ul class="navList" id="allclasses_navbar_bottom">
336<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
337</ul>
338<div>
339<script type="text/javascript"><!--
340 allClassesLink = document.getElementById("allclasses_navbar_bottom");
341 if(window==top) {
342 allClassesLink.style.display = "block";
343 }
344 else {
345 allClassesLink.style.display = "none";
346 }
347 //-->
348</script>
349</div>
350<div>
351<ul class="subNavList">
352<li>Summary:&nbsp;</li>
353<li>Nested&nbsp;|&nbsp;</li>
354<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
355<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
356<li><a href="#method.summary">Method</a></li>
357</ul>
358<ul class="subNavList">
359<li>Detail:&nbsp;</li>
360<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
361<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
362<li><a href="#method.detail">Method</a></li>
363</ul>
364</div>
365<a name="skip.navbar.bottom">
366<!-- -->
367</a></div>
368<!-- ======== END OF BOTTOM NAVBAR ======= -->
369</body>
370</html>
Note: See TracBrowser for help on using the repository browser.