<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_40) on Fri Oct 18 06:47:26 UTC 2013 --> <title>StatisticsRecorderMBean (MX4J API)</title> <meta name="date" content="2013-10-18"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="StatisticsRecorderMBean (MX4J API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/StatisticsRecorderMBean.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../mx4j/tools/stats/PointTime.html" title="class in mx4j.tools.stats"><span class="strong">Prev Class</span></a></li> <li><a href="../../../mx4j/tools/stats/StatisticsRecorderMBeanDescription.html" title="class in mx4j.tools.stats"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?mx4j/tools/stats/StatisticsRecorderMBean.html" target="_top">Frames</a></li> <li><a href="StatisticsRecorderMBean.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">mx4j.tools.stats</div> <h2 title="Interface StatisticsRecorderMBean" class="title">Interface StatisticsRecorderMBean</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Subinterfaces:</dt> <dd><a href="../../../mx4j/tools/stats/ObserverStatisticsRecorderMBean.html" title="interface in mx4j.tools.stats">ObserverStatisticsRecorderMBean</a>, <a href="../../../mx4j/tools/stats/TimedStatisticsRecorderMBean.html" title="interface in mx4j.tools.stats">TimedStatisticsRecorderMBean</a>, <a href="../../../mx4j/tools/stats/ValueStatisticsRecorderMBean.html" title="interface in mx4j.tools.stats">ValueStatisticsRecorderMBean</a></dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../mx4j/tools/stats/AbstractStatisticsRecorder.html" title="class in mx4j.tools.stats">AbstractStatisticsRecorder</a>, <a href="../../../mx4j/tools/stats/NotificationStatisticsRecorder.html" title="class in mx4j.tools.stats">NotificationStatisticsRecorder</a>, <a href="../../../mx4j/tools/stats/ObserverStatisticsRecorder.html" title="class in mx4j.tools.stats">ObserverStatisticsRecorder</a>, <a href="../../../mx4j/tools/stats/TimedStatisticsRecorder.html" title="class in mx4j.tools.stats">TimedStatisticsRecorder</a>, <a href="../../../mx4j/tools/stats/ValueStatisticsRecorder.html" title="class in mx4j.tools.stats">ValueStatisticsRecorder</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">StatisticsRecorderMBean</span></pre> <div class="block">Management interface to be implemented by recorder MBeans. RecorderMBeans store a value and also keep statistics about the given value. Different implementations can determine how to acquire and calculate the value. <p/> The MBean doesn't starts automatically. It has to wait for a <a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#start()"><code>start()</code></a> call</div> <dl><dt><span class="strong">Version:</span></dt> <dd>$Revision: 1.4 $</dd> <dt><span class="strong">See Also:</span></dt><dd><a href="../../../mx4j/tools/stats/PointTime.html" title="class in mx4j.tools.stats"><code>PointTime</code></a></dd></dl> </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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.Number</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getAverage()">getAverage</a></strong>()</code> <div class="block">Returns the Average Value</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.SortedMap</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getEntries()">getEntries</a></strong>()</code> <div class="block">Returs a sorted map of the recorded values indexed by PointTime</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.Number</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getMax()">getMax</a></strong>()</code> <div class="block">Returns the Maximum Value</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getMaxEntries()">getMaxEntries</a></strong>()</code> <div class="block">Returns how many entries may be recorded.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.Number</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getMin()">getMin</a></strong>()</code> <div class="block">Returns the Minimum Value</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Date</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getRecordingStart()">getRecordingStart</a></strong>()</code> <div class="block">Returns the date when it started recording</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#isActive()">isActive</a></strong>()</code> <div class="block">Indicates whether the MBean is recording values</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#setMaxEntries(int)">setMaxEntries</a></strong>(int maxEntries)</code> <div class="block">Sets the maximum entries stored in this recorder</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#start()">start</a></strong>()</code> <div class="block">Starts recording a variable</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#stop()">stop</a></strong>()</code> <div class="block">Stops recording a variable</div> </td> </tr> </table> </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="getMax()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMax</h4> <pre>java.lang.Number getMax()</pre> <div class="block">Returns the Maximum Value</div> </li> </ul> <a name="getAverage()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAverage</h4> <pre>java.lang.Number getAverage()</pre> <div class="block">Returns the Average Value</div> </li> </ul> <a name="getMin()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMin</h4> <pre>java.lang.Number getMin()</pre> <div class="block">Returns the Minimum Value</div> </li> </ul> <a name="getMaxEntries()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMaxEntries</h4> <pre>int getMaxEntries()</pre> <div class="block">Returns how many entries may be recorded. When the maximum amount is reached the default behaviour is to forget the oldest one</div> </li> </ul> <a name="setMaxEntries(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setMaxEntries</h4> <pre>void setMaxEntries(int maxEntries)</pre> <div class="block">Sets the maximum entries stored in this recorder</div> </li> </ul> <a name="getRecordingStart()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRecordingStart</h4> <pre>java.util.Date getRecordingStart()</pre> <div class="block">Returns the date when it started recording</div> </li> </ul> <a name="getEntries()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEntries</h4> <pre>java.util.SortedMap getEntries()</pre> <div class="block">Returs a sorted map of the recorded values indexed by PointTime</div> </li> </ul> <a name="isActive()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isActive</h4> <pre>boolean isActive()</pre> <div class="block">Indicates whether the MBean is recording values</div> </li> </ul> <a name="start()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>start</h4> <pre>void start()</pre> <div class="block">Starts recording a variable</div> </li> </ul> <a name="stop()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>stop</h4> <pre>void stop()</pre> <div class="block">Stops recording a variable</div> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/StatisticsRecorderMBean.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../mx4j/tools/stats/PointTime.html" title="class in mx4j.tools.stats"><span class="strong">Prev Class</span></a></li> <li><a href="../../../mx4j/tools/stats/StatisticsRecorderMBeanDescription.html" title="class in mx4j.tools.stats"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?mx4j/tools/stats/StatisticsRecorderMBean.html" target="_top">Frames</a></li> <li><a href="StatisticsRecorderMBean.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p> </body> </html>