Subversion Repositories SmartDukaan

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
5827 amar.kumar 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc (build 1.6.0_26) on Fri Aug 17 13:40:05 IST 2012 -->
6
<TITLE>
7
Calculator (stat4j API)
8
</TITLE>
9
 
10
<META NAME="date" CONTENT="2012-08-17">
11
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
 
14
<SCRIPT type="text/javascript">
15
function windowTitle()
16
{
17
    if (location.href.indexOf('is-external=true') == -1) {
18
        parent.document.title="Calculator (stat4j API)";
19
    }
20
}
21
</SCRIPT>
22
<NOSCRIPT>
23
</NOSCRIPT>
24
 
25
</HEAD>
26
 
27
<BODY BGCOLOR="white" onload="windowTitle();">
28
<HR>
29
 
30
 
31
<!-- ========= START OF TOP NAVBAR ======= -->
32
<A NAME="navbar_top"><!-- --></A>
33
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35
<TR>
36
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37
<A NAME="navbar_top_firstrow"><!-- --></A>
38
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39
  <TR ALIGN="center" VALIGN="top">
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Calculator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48
  </TR>
49
</TABLE>
50
</TD>
51
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52
</EM>
53
</TD>
54
</TR>
55
 
56
<TR>
57
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58
&nbsp;<A HREF="../../../net/sourceforge/stat4j/AlertTest.html" title="class in net.sourceforge.stat4j"><B>PREV CLASS</B></A>&nbsp;
59
&nbsp;<A HREF="../../../net/sourceforge/stat4j/Filter.html" title="class in net.sourceforge.stat4j"><B>NEXT CLASS</B></A></FONT></TD>
60
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61
  <A HREF="../../../index.html?net/sourceforge/stat4j/Calculator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62
&nbsp;<A HREF="Calculator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63
&nbsp;<SCRIPT type="text/javascript">
64
  <!--
65
  if(window==top) {
66
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
67
  }
68
  //-->
69
</SCRIPT>
70
<NOSCRIPT>
71
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
72
</NOSCRIPT>
73
 
74
 
75
</FONT></TD>
76
</TR>
77
<TR>
78
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82
</TR>
83
</TABLE>
84
<A NAME="skip-navbar_top"></A>
85
<!-- ========= END OF TOP NAVBAR ========= -->
86
 
87
<HR>
88
<!-- ======== START OF CLASS DATA ======== -->
89
<H2>
90
<FONT SIZE="-1">
91
net.sourceforge.stat4j</FONT>
92
<BR>
93
Interface Calculator</H2>
94
<DL>
95
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../net/sourceforge/stat4j/calculators/Average.html" title="class in net.sourceforge.stat4j.calculators">Average</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/CalculatorAdapter.html" title="class in net.sourceforge.stat4j.calculators">CalculatorAdapter</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/Count.html" title="class in net.sourceforge.stat4j.calculators">Count</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/MaxCount.html" title="class in net.sourceforge.stat4j.calculators">MaxCount</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/Maximum.html" title="class in net.sourceforge.stat4j.calculators">Maximum</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/Minimum.html" title="class in net.sourceforge.stat4j.calculators">Minimum</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/Rate.html" title="class in net.sourceforge.stat4j.calculators">Rate</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/RunningCount.html" title="class in net.sourceforge.stat4j.calculators">RunningCount</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/RunningRate.html" title="class in net.sourceforge.stat4j.calculators">RunningRate</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/Simple.html" title="class in net.sourceforge.stat4j.calculators">Simple</A>, <A HREF="../../../net/sourceforge/stat4j/calculators/Sum.html" title="class in net.sourceforge.stat4j.calculators">Sum</A></DD>
96
</DL>
97
<HR>
98
<DL>
99
<DT><PRE>public interface <B>Calculator</B></DL>
100
</PRE>
101
 
102
<P>
103
Name:           Calculator.java
104
 Date:          Aug 29, 2004
105
 Description:
106
 
107
 Calculator contract for all Calculators that calculate/derive
108
 statistic values from metrics. Metrics are are collected/scraped 
109
 from log messages and applies to calculators to calculate 
110
 the statstic value.
111
<P>
112
 
113
<P>
114
<DL>
115
<DT><B>Author:</B></DT>
116
  <DD>Lara D'Abreo</DD>
117
<DT><B>See Also:</B><DD><A HREF="../../../net/sourceforge/stat4j/Metric.html" title="class in net.sourceforge.stat4j"><CODE>Metric</CODE></A>, 
118
<A HREF="../../../net/sourceforge/stat4j/Statistic.html" title="class in net.sourceforge.stat4j"><CODE>Statistic</CODE></A></DL>
119
<HR>
120
 
121
<P>
122
 
123
<!-- ========== METHOD SUMMARY =========== -->
124
 
125
<A NAME="method_summary"><!-- --></A>
126
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
129
<B>Method Summary</B></FONT></TH>
130
</TR>
131
<TR BGCOLOR="white" CLASS="TableRowColor">
132
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133
<CODE>&nbsp;void</CODE></FONT></TD>
134
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#applyMetric(net.sourceforge.stat4j.Metric)">applyMetric</A></B>(<A HREF="../../../net/sourceforge/stat4j/Metric.html" title="class in net.sourceforge.stat4j">Metric</A>&nbsp;metric)</CODE>
135
 
136
<BR>
137
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138
</TR>
139
<TR BGCOLOR="white" CLASS="TableRowColor">
140
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
142
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#getName()">getName</A></B>()</CODE>
143
 
144
<BR>
145
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
146
</TR>
147
<TR BGCOLOR="white" CLASS="TableRowColor">
148
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149
<CODE>&nbsp;double</CODE></FONT></TD>
150
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#getResult()">getResult</A></B>()</CODE>
151
 
152
<BR>
153
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
154
</TR>
155
<TR BGCOLOR="white" CLASS="TableRowColor">
156
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157
<CODE>&nbsp;<A HREF="../../../net/sourceforge/stat4j/Statistic.html" title="class in net.sourceforge.stat4j">Statistic</A></CODE></FONT></TD>
158
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#getStatistic()">getStatistic</A></B>()</CODE>
159
 
160
<BR>
161
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162
</TR>
163
<TR BGCOLOR="white" CLASS="TableRowColor">
164
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165
<CODE>&nbsp;long</CODE></FONT></TD>
166
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#getTimestamp()">getTimestamp</A></B>()</CODE>
167
 
168
<BR>
169
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
170
</TR>
171
<TR BGCOLOR="white" CLASS="TableRowColor">
172
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173
<CODE>&nbsp;void</CODE></FONT></TD>
174
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#init(java.lang.String, java.util.Properties)">init</A></B>(java.lang.String&nbsp;name,
175
     java.util.Properties&nbsp;properties)</CODE>
176
 
177
<BR>
178
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
179
</TR>
180
<TR BGCOLOR="white" CLASS="TableRowColor">
181
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182
<CODE>&nbsp;boolean</CODE></FONT></TD>
183
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#isApplyImmediate()">isApplyImmediate</A></B>()</CODE>
184
 
185
<BR>
186
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
187
</TR>
188
<TR BGCOLOR="white" CLASS="TableRowColor">
189
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190
<CODE>&nbsp;void</CODE></FONT></TD>
191
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#reset()">reset</A></B>()</CODE>
192
 
193
<BR>
194
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
195
</TR>
196
<TR BGCOLOR="white" CLASS="TableRowColor">
197
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198
<CODE>&nbsp;void</CODE></FONT></TD>
199
<TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Calculator.html#setStatistic(net.sourceforge.stat4j.Statistic)">setStatistic</A></B>(<A HREF="../../../net/sourceforge/stat4j/Statistic.html" title="class in net.sourceforge.stat4j">Statistic</A>&nbsp;statistc)</CODE>
200
 
201
<BR>
202
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
203
</TR>
204
</TABLE>
205
&nbsp;
206
<P>
207
 
208
<!-- ============ METHOD DETAIL ========== -->
209
 
210
<A NAME="method_detail"><!-- --></A>
211
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
214
<B>Method Detail</B></FONT></TH>
215
</TR>
216
</TABLE>
217
 
218
<A NAME="getName()"><!-- --></A><H3>
219
getName</H3>
220
<PRE>
221
java.lang.String <B>getName</B>()</PRE>
222
<DL>
223
<DD><DL>
224
</DL>
225
</DD>
226
</DL>
227
<HR>
228
 
229
<A NAME="isApplyImmediate()"><!-- --></A><H3>
230
isApplyImmediate</H3>
231
<PRE>
232
boolean <B>isApplyImmediate</B>()</PRE>
233
<DL>
234
<DD><DL>
235
</DL>
236
</DD>
237
</DL>
238
<HR>
239
 
240
<A NAME="init(java.lang.String, java.util.Properties)"><!-- --></A><H3>
241
init</H3>
242
<PRE>
243
void <B>init</B>(java.lang.String&nbsp;name,
244
          java.util.Properties&nbsp;properties)</PRE>
245
<DL>
246
<DD><DL>
247
</DL>
248
</DD>
249
</DL>
250
<HR>
251
 
252
<A NAME="getStatistic()"><!-- --></A><H3>
253
getStatistic</H3>
254
<PRE>
255
<A HREF="../../../net/sourceforge/stat4j/Statistic.html" title="class in net.sourceforge.stat4j">Statistic</A> <B>getStatistic</B>()</PRE>
256
<DL>
257
<DD><DL>
258
</DL>
259
</DD>
260
</DL>
261
<HR>
262
 
263
<A NAME="setStatistic(net.sourceforge.stat4j.Statistic)"><!-- --></A><H3>
264
setStatistic</H3>
265
<PRE>
266
void <B>setStatistic</B>(<A HREF="../../../net/sourceforge/stat4j/Statistic.html" title="class in net.sourceforge.stat4j">Statistic</A>&nbsp;statistc)</PRE>
267
<DL>
268
<DD><DL>
269
</DL>
270
</DD>
271
</DL>
272
<HR>
273
 
274
<A NAME="applyMetric(net.sourceforge.stat4j.Metric)"><!-- --></A><H3>
275
applyMetric</H3>
276
<PRE>
277
void <B>applyMetric</B>(<A HREF="../../../net/sourceforge/stat4j/Metric.html" title="class in net.sourceforge.stat4j">Metric</A>&nbsp;metric)</PRE>
278
<DL>
279
<DD><DL>
280
</DL>
281
</DD>
282
</DL>
283
<HR>
284
 
285
<A NAME="reset()"><!-- --></A><H3>
286
reset</H3>
287
<PRE>
288
void <B>reset</B>()</PRE>
289
<DL>
290
<DD><DL>
291
</DL>
292
</DD>
293
</DL>
294
<HR>
295
 
296
<A NAME="getResult()"><!-- --></A><H3>
297
getResult</H3>
298
<PRE>
299
double <B>getResult</B>()</PRE>
300
<DL>
301
<DD><DL>
302
</DL>
303
</DD>
304
</DL>
305
<HR>
306
 
307
<A NAME="getTimestamp()"><!-- --></A><H3>
308
getTimestamp</H3>
309
<PRE>
310
long <B>getTimestamp</B>()</PRE>
311
<DL>
312
<DD><DL>
313
</DL>
314
</DD>
315
</DL>
316
<!-- ========= END OF CLASS DATA ========= -->
317
<HR>
318
 
319
 
320
<!-- ======= START OF BOTTOM NAVBAR ====== -->
321
<A NAME="navbar_bottom"><!-- --></A>
322
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
323
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
324
<TR>
325
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
326
<A NAME="navbar_bottom_firstrow"><!-- --></A>
327
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
328
  <TR ALIGN="center" VALIGN="top">
329
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
330
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
331
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
332
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Calculator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
333
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
334
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
335
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
336
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
337
  </TR>
338
</TABLE>
339
</TD>
340
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
341
</EM>
342
</TD>
343
</TR>
344
 
345
<TR>
346
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
347
&nbsp;<A HREF="../../../net/sourceforge/stat4j/AlertTest.html" title="class in net.sourceforge.stat4j"><B>PREV CLASS</B></A>&nbsp;
348
&nbsp;<A HREF="../../../net/sourceforge/stat4j/Filter.html" title="class in net.sourceforge.stat4j"><B>NEXT CLASS</B></A></FONT></TD>
349
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
350
  <A HREF="../../../index.html?net/sourceforge/stat4j/Calculator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
351
&nbsp;<A HREF="Calculator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
352
&nbsp;<SCRIPT type="text/javascript">
353
  <!--
354
  if(window==top) {
355
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
356
  }
357
  //-->
358
</SCRIPT>
359
<NOSCRIPT>
360
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
361
</NOSCRIPT>
362
 
363
 
364
</FONT></TD>
365
</TR>
366
<TR>
367
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
368
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
369
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
370
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
371
</TR>
372
</TABLE>
373
<A NAME="skip-navbar_bottom"></A>
374
<!-- ======== END OF BOTTOM NAVBAR ======= -->
375
 
376
<HR>
377
 
378
</BODY>
379
</HTML>