<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.7.0) on Thu Jan 10 16:02:52 EST 2008 --> <TITLE> StatisticsRecorderMBean (MX4J API) </TITLE> <META NAME="date" CONTENT="2008-01-10"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="StatisticsRecorderMBean (MX4J API)"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StatisticsRecorderMBean.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../mx4j/tools/stats/PointTime.html" title="class in mx4j.tools.stats"><B>PREV CLASS</B></A> <A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBeanDescription.html" title="class in mx4j.tools.stats"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?mx4j/tools/stats/StatisticsRecorderMBean.html" target="_top"><B>FRAMES</B></A> <A HREF="StatisticsRecorderMBean.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> mx4j.tools.stats</FONT> <BR> Interface StatisticsRecorderMBean</H2> <DL> <DT><B>All Known Subinterfaces:</B> <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><B>All Known Implementing Classes:</B> <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> <DL> <DT><PRE>public interface <B>StatisticsRecorderMBean</B></DL> </PRE> <P> 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 <P> <P> <DL> <DT><B>Version:</B></DT> <DD>$Revision: 1.4 $</DD> <DT><B>See Also:</B><DD><A HREF="../../../mx4j/tools/stats/PointTime.html" title="class in mx4j.tools.stats"><CODE>PointTime</CODE></A></DL> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Number</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getAverage()">getAverage</A></B>()</CODE> <BR> Returns the Average Value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedMap</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getEntries()">getEntries</A></B>()</CODE> <BR> Returs a sorted map of the recorded values indexed by PointTime</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Number</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getMax()">getMax</A></B>()</CODE> <BR> Returns the Maximum Value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getMaxEntries()">getMaxEntries</A></B>()</CODE> <BR> Returns how many entries may be recorded.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Number</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getMin()">getMin</A></B>()</CODE> <BR> Returns the Minimum Value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Date</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#getRecordingStart()">getRecordingStart</A></B>()</CODE> <BR> Returns the date when it started recording</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#isActive()">isActive</A></B>()</CODE> <BR> Indicates whether the MBean is recording values</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#setMaxEntries(int)">setMaxEntries</A></B>(int maxEntries)</CODE> <BR> Sets the maximum entries stored in this recorder</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#start()">start</A></B>()</CODE> <BR> Starts recording a variable</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBean.html#stop()">stop</A></B>()</CODE> <BR> Stops recording a variable</TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getMax()"><!-- --></A><H3> getMax</H3> <PRE> java.lang.Number <B>getMax</B>()</PRE> <DL> <DD>Returns the Maximum Value <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getAverage()"><!-- --></A><H3> getAverage</H3> <PRE> java.lang.Number <B>getAverage</B>()</PRE> <DL> <DD>Returns the Average Value <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getMin()"><!-- --></A><H3> getMin</H3> <PRE> java.lang.Number <B>getMin</B>()</PRE> <DL> <DD>Returns the Minimum Value <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getMaxEntries()"><!-- --></A><H3> getMaxEntries</H3> <PRE> int <B>getMaxEntries</B>()</PRE> <DL> <DD>Returns how many entries may be recorded. When the maximum amount is reached the default behaviour is to forget the oldest one <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setMaxEntries(int)"><!-- --></A><H3> setMaxEntries</H3> <PRE> void <B>setMaxEntries</B>(int maxEntries)</PRE> <DL> <DD>Sets the maximum entries stored in this recorder <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getRecordingStart()"><!-- --></A><H3> getRecordingStart</H3> <PRE> java.util.Date <B>getRecordingStart</B>()</PRE> <DL> <DD>Returns the date when it started recording <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getEntries()"><!-- --></A><H3> getEntries</H3> <PRE> java.util.SortedMap <B>getEntries</B>()</PRE> <DL> <DD>Returs a sorted map of the recorded values indexed by PointTime <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isActive()"><!-- --></A><H3> isActive</H3> <PRE> boolean <B>isActive</B>()</PRE> <DL> <DD>Indicates whether the MBean is recording values <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="start()"><!-- --></A><H3> start</H3> <PRE> void <B>start</B>()</PRE> <DL> <DD>Starts recording a variable <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="stop()"><!-- --></A><H3> stop</H3> <PRE> void <B>stop</B>()</PRE> <DL> <DD>Stops recording a variable <P> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StatisticsRecorderMBean.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../mx4j/tools/stats/PointTime.html" title="class in mx4j.tools.stats"><B>PREV CLASS</B></A> <A HREF="../../../mx4j/tools/stats/StatisticsRecorderMBeanDescription.html" title="class in mx4j.tools.stats"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?mx4j/tools/stats/StatisticsRecorderMBean.html" target="_top"><B>FRAMES</B></A> <A HREF="StatisticsRecorderMBean.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center> </BODY> </HTML>