source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/handler/component/StatsValues.html @ 7588

Revision 7588, 15.6 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
Line 
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_24) on Mon Jun 25 15:26:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8StatsValues (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="StatsValues (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StatsValues.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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="../../../../../org/apache/solr/handler/component/StatsComponent.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/StatsValuesFactory.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/handler/component/StatsValues.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="StatsValues.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">
81DETAIL:&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">
91org.apache.solr.handler.component</FONT>
92<BR>
93Interface StatsValues</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>StatsValues</B></DL>
97</PRE>
98
99<P>
100StatsValue defines the interface for the collection of statistical values about fields and facets.
101<P>
102
103<P>
104<HR>
105
106<P>
107
108<!-- ========== METHOD SUMMARY =========== -->
109
110<A NAME="method_summary"><!-- --></A>
111<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
112<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
113<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
114<B>Method Summary</B></FONT></TH>
115</TR>
116<TR BGCOLOR="white" CLASS="TableRowColor">
117<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
118<CODE>&nbsp;void</CODE></FONT></TD>
119<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#accumulate(org.apache.lucene.util.BytesRef)">accumulate</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&nbsp;value)</CODE>
120
121<BR>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Accumulate the values based on the given value</TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>&nbsp;void</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#accumulate(org.apache.lucene.util.BytesRef, int)">accumulate</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&nbsp;value,
128           int&nbsp;count)</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Accumulate the values based on the given value</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>&nbsp;void</CODE></FONT></TD>
136<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#accumulate(org.apache.solr.common.util.NamedList)">accumulate</A></B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;stv)</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Accumulate the values based on those in the given NamedList</TD>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143<CODE>&nbsp;void</CODE></FONT></TD>
144<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#addFacet(java.lang.String, java.util.Map)">addFacet</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;facetName,
145         <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html" title="interface in org.apache.solr.handler.component">StatsValues</A>&gt;&nbsp;facetValues)</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the facet statistics for the facet with the given name</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;void</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#addMissing(int)">addMissing</A></B>(int&nbsp;count)</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Updates the statistics when multiple documents are missing a value</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;?&gt;</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#getStatsValues()">getStatsValues</A></B>()</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates the values into a NamedList representation</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html#missing()">missing</A></B>()</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Updates the statistics when a document is missing a value</TD>
173</TR>
174</TABLE>
175&nbsp;
176<P>
177
178<!-- ============ METHOD DETAIL ========== -->
179
180<A NAME="method_detail"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
184<B>Method Detail</B></FONT></TH>
185</TR>
186</TABLE>
187
188<A NAME="accumulate(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
189accumulate</H3>
190<PRE>
191void <B>accumulate</B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;stv)</PRE>
192<DL>
193<DD>Accumulate the values based on those in the given NamedList
194<P>
195<DD><DL>
196<DT><B>Parameters:</B><DD><CODE>stv</CODE> - NamedList whose values will be used to accumulate the current values</DL>
197</DD>
198</DL>
199<HR>
200
201<A NAME="accumulate(org.apache.lucene.util.BytesRef)"><!-- --></A><H3>
202accumulate</H3>
203<PRE>
204void <B>accumulate</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&nbsp;value)</PRE>
205<DL>
206<DD>Accumulate the values based on the given value
207<P>
208<DD><DL>
209<DT><B>Parameters:</B><DD><CODE>value</CODE> - Value to use to accumulate the current values</DL>
210</DD>
211</DL>
212<HR>
213
214<A NAME="accumulate(org.apache.lucene.util.BytesRef, int)"><!-- --></A><H3>
215accumulate</H3>
216<PRE>
217void <B>accumulate</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&nbsp;value,
218                int&nbsp;count)</PRE>
219<DL>
220<DD>Accumulate the values based on the given value
221<P>
222<DD><DL>
223<DT><B>Parameters:</B><DD><CODE>value</CODE> - Value to use to accumulate the current values<DD><CODE>count</CODE> - number of times to accumulate this value</DL>
224</DD>
225</DL>
226<HR>
227
228<A NAME="missing()"><!-- --></A><H3>
229missing</H3>
230<PRE>
231void <B>missing</B>()</PRE>
232<DL>
233<DD>Updates the statistics when a document is missing a value
234<P>
235<DD><DL>
236</DL>
237</DD>
238</DL>
239<HR>
240
241<A NAME="addMissing(int)"><!-- --></A><H3>
242addMissing</H3>
243<PRE>
244void <B>addMissing</B>(int&nbsp;count)</PRE>
245<DL>
246<DD>Updates the statistics when multiple documents are missing a value
247<P>
248<DD><DL>
249<DT><B>Parameters:</B><DD><CODE>count</CODE> - number of times to count a missing value</DL>
250</DD>
251</DL>
252<HR>
253
254<A NAME="addFacet(java.lang.String, java.util.Map)"><!-- --></A><H3>
255addFacet</H3>
256<PRE>
257void <B>addFacet</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;facetName,
258              <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../../org/apache/solr/handler/component/StatsValues.html" title="interface in org.apache.solr.handler.component">StatsValues</A>&gt;&nbsp;facetValues)</PRE>
259<DL>
260<DD>Adds the facet statistics for the facet with the given name
261<P>
262<DD><DL>
263<DT><B>Parameters:</B><DD><CODE>facetName</CODE> - Name of the facet<DD><CODE>facetValues</CODE> - Facet statistics on a per facet value basis</DL>
264</DD>
265</DL>
266<HR>
267
268<A NAME="getStatsValues()"><!-- --></A><H3>
269getStatsValues</H3>
270<PRE>
271<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;?&gt; <B>getStatsValues</B>()</PRE>
272<DL>
273<DD>Translates the values into a NamedList representation
274<P>
275<DD><DL>
276
277<DT><B>Returns:</B><DD>NamedList representation of the current values</DL>
278</DD>
279</DL>
280<!-- ========= END OF CLASS DATA ========= -->
281<HR>
282
283
284<!-- ======= START OF BOTTOM NAVBAR ====== -->
285<A NAME="navbar_bottom"><!-- --></A>
286<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
287<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
288<TR>
289<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
290<A NAME="navbar_bottom_firstrow"><!-- --></A>
291<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
292  <TR ALIGN="center" VALIGN="top">
293  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
294  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
295  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
296  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StatsValues.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
297  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
298  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
299  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
300  </TR>
301</TABLE>
302</TD>
303<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
304</EM>
305</TD>
306</TR>
307
308<TR>
309<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
310&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/StatsComponent.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
311&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/StatsValuesFactory.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
312<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
313  <A HREF="../../../../../index.html?org/apache/solr/handler/component/StatsValues.html" target="_top"><B>FRAMES</B></A>  &nbsp;
314&nbsp;<A HREF="StatsValues.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
315&nbsp;<SCRIPT type="text/javascript">
316  <!--
317  if(window==top) {
318    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
319  }
320  //-->
321</SCRIPT>
322<NOSCRIPT>
323  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
324</NOSCRIPT>
325
326
327</FONT></TD>
328</TR>
329<TR>
330<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
331  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
332<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
333DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
334</TR>
335</TABLE>
336<A NAME="skip-navbar_bottom"></A>
337<!-- ======== END OF BOTTOM NAVBAR ======= -->
338
339<HR>
340
341          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
342          <script src='../../../../../prettify.js' type='text/javascript'></script>
343          <script type='text/javascript'>
344            (function(){
345              var oldonload = window.onload;
346              if (typeof oldonload != 'function') {
347                window.onload = prettyPrint;
348              } else {
349                window.onload = function() {
350                  oldonload();
351                  prettyPrint();
352                }
353              }
354            })();
355          </script>
356       
357</BODY>
358</HTML>
Note: See TracBrowser for help on using the repository browser.