source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/common/params/FacetParams.html @ 7588

Revision 7588, 51.3 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:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8FacetParams (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="FacetParams (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/FacetParams.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/common/params/EventParams.html" title="interface in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetDateOther.html" title="enum in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/common/params/FacetParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FacetParams.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</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.common.params</FONT>
92<BR>
93Interface FacetParams</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>FacetParams</B></DL>
97</PRE>
98
99<P>
100Facet parameters
101<P>
102
103<P>
104<HR>
105
106<P>
107<!-- ======== NESTED CLASS SUMMARY ======== -->
108
109<A NAME="nested_class_summary"><!-- --></A>
110<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113<B>Nested Class Summary</B></FONT></TH>
114</TR>
115<TR BGCOLOR="white" CLASS="TableRowColor">
116<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117<CODE>static&nbsp;class</CODE></FONT></TD>
118<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetDateOther.html" title="enum in org.apache.solr.common.params">FacetParams.FacetDateOther</A></B></CODE>
119
120<BR>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeOther.html" title="enum in org.apache.solr.common.params"><CODE>FacetParams.FacetRangeOther</CODE></A></I></TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>static&nbsp;class</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeInclude.html" title="enum in org.apache.solr.common.params">FacetParams.FacetRangeInclude</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An enumeration of the legal values for <A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_INCLUDE"><CODE>FACET_DATE_INCLUDE</CODE></A> and <A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_INCLUDE"><CODE>FACET_RANGE_INCLUDE</CODE></A>
130
131 
132 lower = all gap based ranges include their lower bound
133 upper = all gap based ranges include their upper bound
134 edge = the first and last gap ranges include their edge bounds (ie: lower
135     for the first one, upper for the last one) even if the corresponding
136     upper/lower option is not specified
137 
138 outer = the BEFORE and AFTER ranges
139     should be inclusive of their bounds, even if the first or last ranges
140     already include those boundaries.</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>static&nbsp;class</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeOther.html" title="enum in org.apache.solr.common.params">FacetParams.FacetRangeOther</A></B></CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An enumeration of the legal values for <A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_OTHER"><CODE>FACET_RANGE_OTHER</CODE></A> and <A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_OTHER"><CODE>FACET_DATE_OTHER</CODE></A> ...</TD>
149</TR>
150</TABLE>
151&nbsp;<!-- =========== FIELD SUMMARY =========== -->
152
153<A NAME="field_summary"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
156<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
157<B>Field Summary</B></FONT></TH>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>static&nbsp;<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></CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET">FACET</A></B></CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should facet counts be calculated?</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>static&nbsp;<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></CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE">FACET_DATE</A></B></CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Any field whose terms the user wants to enumerate over for
174 Facet Contraint Counts (multi-value)</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>static&nbsp;<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></CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_END">FACET_DATE_END</A></B></CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date string indicating the endinging point for a date facet range.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>static&nbsp;<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></CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_GAP">FACET_DATE_GAP</A></B></CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date Math string indicating the interval of sub-ranges for a date
191 facet range.</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>static&nbsp;<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></CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_HARD_END">FACET_DATE_HARD_END</A></B></CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean indicating how counts should be computed if the range
200 between 'start' and 'end' is not evenly divisible by 'gap'.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>static&nbsp;<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></CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_INCLUDE">FACET_DATE_INCLUDE</A></B></CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
209 Multivalued string indicating what rules should be applied to determine
210 when the the ranges generated for date faceting should be inclusive or
211 exclusive of their end points.</TD>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<CODE>static&nbsp;<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></CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_OTHER">FACET_DATE_OTHER</A></B></CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;String indicating what "other" ranges should be computed for a
220 date facet range (multi-value).</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>static&nbsp;<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></CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_DATE_START">FACET_DATE_START</A></B></CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date string indicating the starting point for a date facet range.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>static&nbsp;<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></CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_ENUM_CACHE_MINDF">FACET_ENUM_CACHE_MINDF</A></B></CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When faceting by enumerating the terms in a field,
237 only use the filterCache for terms with a df >= to this parameter.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>static&nbsp;<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></CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_FIELD">FACET_FIELD</A></B></CODE>
243
244<BR>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Any field whose terms the user wants to enumerate over for
246 Facet Constraint Counts (multi-value)</TD>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250<CODE>static&nbsp;<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></CODE></FONT></TD>
251<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_LIMIT">FACET_LIMIT</A></B></CODE>
252
253<BR>
254&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Numeric option indicating the maximum number of facet field counts
255 be included in the response for each field - in descending order of count.</TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<CODE>static&nbsp;<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></CODE></FONT></TD>
260<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_METHOD">FACET_METHOD</A></B></CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;What method should be used to do the faceting</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>static&nbsp;<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></CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_METHOD_enum">FACET_METHOD_enum</A></B></CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for FACET_METHOD param to indicate that Solr should enumerate over terms
272 in a field to calculate the facet counts.</TD>
273</TR>
274<TR BGCOLOR="white" CLASS="TableRowColor">
275<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276<CODE>static&nbsp;<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></CODE></FONT></TD>
277<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_METHOD_fc">FACET_METHOD_fc</A></B></CODE>
278
279<BR>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for FACET_METHOD param to indicate that Solr should enumerate over documents
281 and count up terms by consulting an uninverted representation of the field values
282 (such as the FieldCache used for sorting).</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>static&nbsp;<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></CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_METHOD_fcs">FACET_METHOD_fcs</A></B></CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for FACET_METHOD param, like FACET_METHOD_fc but counts per-segment.</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>static&nbsp;<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></CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_MINCOUNT">FACET_MINCOUNT</A></B></CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Numeric option indicating the minimum number of hits before a facet should
299 be included in the response.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>static&nbsp;<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></CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_MISSING">FACET_MISSING</A></B></CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean option indicating whether the response should include a
308 facet field count for all records which have no value for the
309 facet field.</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>static&nbsp;<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></CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_OFFSET">FACET_OFFSET</A></B></CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The offset into the list of facets.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>static&nbsp;<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></CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_PIVOT">FACET_PIVOT</A></B></CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comma separated list of fields to pivot
326 
327 example: author,type  (for types by author / types within author)</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>static&nbsp;<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></CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_PIVOT_MINCOUNT">FACET_PIVOT_MINCOUNT</A></B></CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Minimum number of docs that need to match to be included in the sublist
336 
337 default value is 1</TD>
338</TR>
339<TR BGCOLOR="white" CLASS="TableRowColor">
340<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341<CODE>static&nbsp;<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></CODE></FONT></TD>
342<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_PREFIX">FACET_PREFIX</A></B></CODE>
343
344<BR>
345&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Only return constraints of a facet field with the given prefix.</TD>
346</TR>
347<TR BGCOLOR="white" CLASS="TableRowColor">
348<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349<CODE>static&nbsp;<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></CODE></FONT></TD>
350<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_QUERY">FACET_QUERY</A></B></CODE>
351
352<BR>
353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Any lucene formated queries the user would like to use for
354 Facet Constraint Counts (multi-value)</TD>
355</TR>
356<TR BGCOLOR="white" CLASS="TableRowColor">
357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358<CODE>static&nbsp;<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></CODE></FONT></TD>
359<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE">FACET_RANGE</A></B></CODE>
360
361<BR>
362&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Any numerical field whose terms the user wants to enumerate over
363 Facet Contraint Counts for selected ranges.</TD>
364</TR>
365<TR BGCOLOR="white" CLASS="TableRowColor">
366<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
367<CODE>static&nbsp;<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></CODE></FONT></TD>
368<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_END">FACET_RANGE_END</A></B></CODE>
369
370<BR>
371&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number indicating the ending point for a numerical range facet.</TD>
372</TR>
373<TR BGCOLOR="white" CLASS="TableRowColor">
374<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375<CODE>static&nbsp;<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></CODE></FONT></TD>
376<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_GAP">FACET_RANGE_GAP</A></B></CODE>
377
378<BR>
379&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number indicating the interval of sub-ranges for a numerical
380 facet range.</TD>
381</TR>
382<TR BGCOLOR="white" CLASS="TableRowColor">
383<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
384<CODE>static&nbsp;<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></CODE></FONT></TD>
385<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_HARD_END">FACET_RANGE_HARD_END</A></B></CODE>
386
387<BR>
388&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean indicating how counts should be computed if the range
389 between 'start' and 'end' is not evenly divisible by 'gap'.</TD>
390</TR>
391<TR BGCOLOR="white" CLASS="TableRowColor">
392<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
393<CODE>static&nbsp;<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></CODE></FONT></TD>
394<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_INCLUDE">FACET_RANGE_INCLUDE</A></B></CODE>
395
396<BR>
397&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
398 Multivalued string indicating what rules should be applied to determine
399 when the the ranges generated for numeric faceting should be inclusive or
400 exclusive of their end points.</TD>
401</TR>
402<TR BGCOLOR="white" CLASS="TableRowColor">
403<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
404<CODE>static&nbsp;<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></CODE></FONT></TD>
405<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_OTHER">FACET_RANGE_OTHER</A></B></CODE>
406
407<BR>
408&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;String indicating what "other" ranges should be computed for a
409 numerical range facet (multi-value).</TD>
410</TR>
411<TR BGCOLOR="white" CLASS="TableRowColor">
412<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
413<CODE>static&nbsp;<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></CODE></FONT></TD>
414<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_START">FACET_RANGE_START</A></B></CODE>
415
416<BR>
417&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number indicating the starting point for a numerical range facet.</TD>
418</TR>
419<TR BGCOLOR="white" CLASS="TableRowColor">
420<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421<CODE>static&nbsp;<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></CODE></FONT></TD>
422<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_SORT">FACET_SORT</A></B></CODE>
423
424<BR>
425&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;String option: "count" causes facets to be sorted
426 by the count, "index" results in index order.</TD>
427</TR>
428<TR BGCOLOR="white" CLASS="TableRowColor">
429<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
430<CODE>static&nbsp;<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></CODE></FONT></TD>
431<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_SORT_COUNT">FACET_SORT_COUNT</A></B></CODE>
432
433<BR>
434&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
435</TR>
436<TR BGCOLOR="white" CLASS="TableRowColor">
437<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
438<CODE>static&nbsp;<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></CODE></FONT></TD>
439<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_SORT_COUNT_LEGACY">FACET_SORT_COUNT_LEGACY</A></B></CODE>
440
441<BR>
442&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
443</TR>
444<TR BGCOLOR="white" CLASS="TableRowColor">
445<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
446<CODE>static&nbsp;<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></CODE></FONT></TD>
447<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_SORT_INDEX">FACET_SORT_INDEX</A></B></CODE>
448
449<BR>
450&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
451</TR>
452<TR BGCOLOR="white" CLASS="TableRowColor">
453<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454<CODE>static&nbsp;<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></CODE></FONT></TD>
455<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_SORT_INDEX_LEGACY">FACET_SORT_INDEX_LEGACY</A></B></CODE>
456
457<BR>
458&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
459</TR>
460<TR BGCOLOR="white" CLASS="TableRowColor">
461<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462<CODE>static&nbsp;<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></CODE></FONT></TD>
463<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_ZEROS">FACET_ZEROS</A></B></CODE>
464
465<BR>
466&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean option indicating whether facet field counts of "0" should
467 be included in the response.</TD>
468</TR>
469</TABLE>
470&nbsp;
471<P>
472
473<!-- ============ FIELD DETAIL =========== -->
474
475<A NAME="field_detail"><!-- --></A>
476<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
477<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
478<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
479<B>Field Detail</B></FONT></TH>
480</TR>
481</TABLE>
482
483<A NAME="FACET"><!-- --></A><H3>
484FACET</H3>
485<PRE>
486static final <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> <B>FACET</B></PRE>
487<DL>
488<DD>Should facet counts be calculated?
489<P>
490<DL>
491<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET">Constant Field Values</A></DL>
492</DL>
493<HR>
494
495<A NAME="FACET_METHOD"><!-- --></A><H3>
496FACET_METHOD</H3>
497<PRE>
498static final <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> <B>FACET_METHOD</B></PRE>
499<DL>
500<DD>What method should be used to do the faceting
501<P>
502<DL>
503<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_METHOD">Constant Field Values</A></DL>
504</DL>
505<HR>
506
507<A NAME="FACET_METHOD_enum"><!-- --></A><H3>
508FACET_METHOD_enum</H3>
509<PRE>
510static final <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> <B>FACET_METHOD_enum</B></PRE>
511<DL>
512<DD>Value for FACET_METHOD param to indicate that Solr should enumerate over terms
513 in a field to calculate the facet counts.
514<P>
515<DL>
516<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_METHOD_enum">Constant Field Values</A></DL>
517</DL>
518<HR>
519
520<A NAME="FACET_METHOD_fc"><!-- --></A><H3>
521FACET_METHOD_fc</H3>
522<PRE>
523static final <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> <B>FACET_METHOD_fc</B></PRE>
524<DL>
525<DD>Value for FACET_METHOD param to indicate that Solr should enumerate over documents
526 and count up terms by consulting an uninverted representation of the field values
527 (such as the FieldCache used for sorting).
528<P>
529<DL>
530<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_METHOD_fc">Constant Field Values</A></DL>
531</DL>
532<HR>
533
534<A NAME="FACET_METHOD_fcs"><!-- --></A><H3>
535FACET_METHOD_fcs</H3>
536<PRE>
537static final <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> <B>FACET_METHOD_fcs</B></PRE>
538<DL>
539<DD>Value for FACET_METHOD param, like FACET_METHOD_fc but counts per-segment.
540<P>
541<DL>
542<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_METHOD_fcs">Constant Field Values</A></DL>
543</DL>
544<HR>
545
546<A NAME="FACET_QUERY"><!-- --></A><H3>
547FACET_QUERY</H3>
548<PRE>
549static final <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> <B>FACET_QUERY</B></PRE>
550<DL>
551<DD>Any lucene formated queries the user would like to use for
552 Facet Constraint Counts (multi-value)
553<P>
554<DL>
555<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_QUERY">Constant Field Values</A></DL>
556</DL>
557<HR>
558
559<A NAME="FACET_FIELD"><!-- --></A><H3>
560FACET_FIELD</H3>
561<PRE>
562static final <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> <B>FACET_FIELD</B></PRE>
563<DL>
564<DD>Any field whose terms the user wants to enumerate over for
565 Facet Constraint Counts (multi-value)
566<P>
567<DL>
568<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_FIELD">Constant Field Values</A></DL>
569</DL>
570<HR>
571
572<A NAME="FACET_OFFSET"><!-- --></A><H3>
573FACET_OFFSET</H3>
574<PRE>
575static final <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> <B>FACET_OFFSET</B></PRE>
576<DL>
577<DD>The offset into the list of facets.
578 Can be overridden on a per field basis.
579<P>
580<DL>
581<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_OFFSET">Constant Field Values</A></DL>
582</DL>
583<HR>
584
585<A NAME="FACET_LIMIT"><!-- --></A><H3>
586FACET_LIMIT</H3>
587<PRE>
588static final <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> <B>FACET_LIMIT</B></PRE>
589<DL>
590<DD>Numeric option indicating the maximum number of facet field counts
591 be included in the response for each field - in descending order of count.
592 Can be overridden on a per field basis.
593<P>
594<DL>
595<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_LIMIT">Constant Field Values</A></DL>
596</DL>
597<HR>
598
599<A NAME="FACET_MINCOUNT"><!-- --></A><H3>
600FACET_MINCOUNT</H3>
601<PRE>
602static final <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> <B>FACET_MINCOUNT</B></PRE>
603<DL>
604<DD>Numeric option indicating the minimum number of hits before a facet should
605 be included in the response.  Can be overridden on a per field basis.
606<P>
607<DL>
608<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_MINCOUNT">Constant Field Values</A></DL>
609</DL>
610<HR>
611
612<A NAME="FACET_ZEROS"><!-- --></A><H3>
613FACET_ZEROS</H3>
614<PRE>
615static final <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> <B>FACET_ZEROS</B></PRE>
616<DL>
617<DD>Boolean option indicating whether facet field counts of "0" should
618 be included in the response.  Can be overridden on a per field basis.
619<P>
620<DL>
621<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_ZEROS">Constant Field Values</A></DL>
622</DL>
623<HR>
624
625<A NAME="FACET_MISSING"><!-- --></A><H3>
626FACET_MISSING</H3>
627<PRE>
628static final <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> <B>FACET_MISSING</B></PRE>
629<DL>
630<DD>Boolean option indicating whether the response should include a
631 facet field count for all records which have no value for the
632 facet field. Can be overridden on a per field basis.
633<P>
634<DL>
635<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_MISSING">Constant Field Values</A></DL>
636</DL>
637<HR>
638
639<A NAME="FACET_PIVOT"><!-- --></A><H3>
640FACET_PIVOT</H3>
641<PRE>
642static final <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> <B>FACET_PIVOT</B></PRE>
643<DL>
644<DD>Comma separated list of fields to pivot
645 
646 example: author,type  (for types by author / types within author)
647<P>
648<DL>
649<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_PIVOT">Constant Field Values</A></DL>
650</DL>
651<HR>
652
653<A NAME="FACET_PIVOT_MINCOUNT"><!-- --></A><H3>
654FACET_PIVOT_MINCOUNT</H3>
655<PRE>
656static final <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> <B>FACET_PIVOT_MINCOUNT</B></PRE>
657<DL>
658<DD>Minimum number of docs that need to match to be included in the sublist
659 
660 default value is 1
661<P>
662<DL>
663<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_PIVOT_MINCOUNT">Constant Field Values</A></DL>
664</DL>
665<HR>
666
667<A NAME="FACET_SORT"><!-- --></A><H3>
668FACET_SORT</H3>
669<PRE>
670static final <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> <B>FACET_SORT</B></PRE>
671<DL>
672<DD>String option: "count" causes facets to be sorted
673 by the count, "index" results in index order.
674<P>
675<DL>
676<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_SORT">Constant Field Values</A></DL>
677</DL>
678<HR>
679
680<A NAME="FACET_SORT_COUNT"><!-- --></A><H3>
681FACET_SORT_COUNT</H3>
682<PRE>
683static final <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> <B>FACET_SORT_COUNT</B></PRE>
684<DL>
685<DL>
686<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_SORT_COUNT">Constant Field Values</A></DL>
687</DL>
688<HR>
689
690<A NAME="FACET_SORT_COUNT_LEGACY"><!-- --></A><H3>
691FACET_SORT_COUNT_LEGACY</H3>
692<PRE>
693static final <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> <B>FACET_SORT_COUNT_LEGACY</B></PRE>
694<DL>
695<DL>
696<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_SORT_COUNT_LEGACY">Constant Field Values</A></DL>
697</DL>
698<HR>
699
700<A NAME="FACET_SORT_INDEX"><!-- --></A><H3>
701FACET_SORT_INDEX</H3>
702<PRE>
703static final <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> <B>FACET_SORT_INDEX</B></PRE>
704<DL>
705<DL>
706<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_SORT_INDEX">Constant Field Values</A></DL>
707</DL>
708<HR>
709
710<A NAME="FACET_SORT_INDEX_LEGACY"><!-- --></A><H3>
711FACET_SORT_INDEX_LEGACY</H3>
712<PRE>
713static final <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> <B>FACET_SORT_INDEX_LEGACY</B></PRE>
714<DL>
715<DL>
716<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_SORT_INDEX_LEGACY">Constant Field Values</A></DL>
717</DL>
718<HR>
719
720<A NAME="FACET_PREFIX"><!-- --></A><H3>
721FACET_PREFIX</H3>
722<PRE>
723static final <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> <B>FACET_PREFIX</B></PRE>
724<DL>
725<DD>Only return constraints of a facet field with the given prefix.
726<P>
727<DL>
728<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_PREFIX">Constant Field Values</A></DL>
729</DL>
730<HR>
731
732<A NAME="FACET_ENUM_CACHE_MINDF"><!-- --></A><H3>
733FACET_ENUM_CACHE_MINDF</H3>
734<PRE>
735static final <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> <B>FACET_ENUM_CACHE_MINDF</B></PRE>
736<DL>
737<DD>When faceting by enumerating the terms in a field,
738 only use the filterCache for terms with a df >= to this parameter.
739<P>
740<DL>
741<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_ENUM_CACHE_MINDF">Constant Field Values</A></DL>
742</DL>
743<HR>
744
745<A NAME="FACET_DATE"><!-- --></A><H3>
746FACET_DATE</H3>
747<PRE>
748static final <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> <B>FACET_DATE</B></PRE>
749<DL>
750<DD>Any field whose terms the user wants to enumerate over for
751 Facet Contraint Counts (multi-value)
752<P>
753<DL>
754<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE">Constant Field Values</A></DL>
755</DL>
756<HR>
757
758<A NAME="FACET_DATE_START"><!-- --></A><H3>
759FACET_DATE_START</H3>
760<PRE>
761static final <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> <B>FACET_DATE_START</B></PRE>
762<DL>
763<DD>Date string indicating the starting point for a date facet range.
764 Can be overriden on a per field basis.
765<P>
766<DL>
767<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE_START">Constant Field Values</A></DL>
768</DL>
769<HR>
770
771<A NAME="FACET_DATE_END"><!-- --></A><H3>
772FACET_DATE_END</H3>
773<PRE>
774static final <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> <B>FACET_DATE_END</B></PRE>
775<DL>
776<DD>Date string indicating the endinging point for a date facet range.
777 Can be overriden on a per field basis.
778<P>
779<DL>
780<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE_END">Constant Field Values</A></DL>
781</DL>
782<HR>
783
784<A NAME="FACET_DATE_GAP"><!-- --></A><H3>
785FACET_DATE_GAP</H3>
786<PRE>
787static final <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> <B>FACET_DATE_GAP</B></PRE>
788<DL>
789<DD>Date Math string indicating the interval of sub-ranges for a date
790 facet range.
791 Can be overriden on a per field basis.
792<P>
793<DL>
794<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE_GAP">Constant Field Values</A></DL>
795</DL>
796<HR>
797
798<A NAME="FACET_DATE_HARD_END"><!-- --></A><H3>
799FACET_DATE_HARD_END</H3>
800<PRE>
801static final <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> <B>FACET_DATE_HARD_END</B></PRE>
802<DL>
803<DD>Boolean indicating how counts should be computed if the range
804 between 'start' and 'end' is not evenly divisible by 'gap'.  If
805 this value is true, then all counts of ranges involving the 'end'
806 point will use the exact endpoint specified -- this includes the
807 'between' and 'after' counts as well as the last range computed
808 using the 'gap'.  If the value is false, then 'gap' is used to
809 compute the effective endpoint closest to the 'end' param which
810 results in the range between 'start' and 'end' being evenly
811 divisible by 'gap'.
812 The default is false.
813 Can be overriden on a per field basis.
814<P>
815<DL>
816<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE_HARD_END">Constant Field Values</A></DL>
817</DL>
818<HR>
819
820<A NAME="FACET_DATE_OTHER"><!-- --></A><H3>
821FACET_DATE_OTHER</H3>
822<PRE>
823static final <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> <B>FACET_DATE_OTHER</B></PRE>
824<DL>
825<DD>String indicating what "other" ranges should be computed for a
826 date facet range (multi-value).
827 Can be overriden on a per field basis.
828<P>
829<DL>
830<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeOther.html" title="enum in org.apache.solr.common.params"><CODE>FacetParams.FacetRangeOther</CODE></A>,
831<A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE_OTHER">Constant Field Values</A></DL>
832</DL>
833<HR>
834
835<A NAME="FACET_DATE_INCLUDE"><!-- --></A><H3>
836FACET_DATE_INCLUDE</H3>
837<PRE>
838static final <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> <B>FACET_DATE_INCLUDE</B></PRE>
839<DL>
840<DD><p>
841 Multivalued string indicating what rules should be applied to determine
842 when the the ranges generated for date faceting should be inclusive or
843 exclusive of their end points.
844 </p>
845 <p>
846 The default value if none are specified is: [lower,upper,edge] <i>(NOTE: This is different then FACET_RANGE_INCLUDE)</i>
847 </p>
848 <p>
849 Can be overriden on a per field basis.
850 </p>
851<P>
852<DL>
853<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeInclude.html" title="enum in org.apache.solr.common.params"><CODE>FacetParams.FacetRangeInclude</CODE></A>,
854<A HREF="../../../../../org/apache/solr/common/params/FacetParams.html#FACET_RANGE_INCLUDE"><CODE>FACET_RANGE_INCLUDE</CODE></A>,
855<A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_DATE_INCLUDE">Constant Field Values</A></DL>
856</DL>
857<HR>
858
859<A NAME="FACET_RANGE"><!-- --></A><H3>
860FACET_RANGE</H3>
861<PRE>
862static final <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> <B>FACET_RANGE</B></PRE>
863<DL>
864<DD>Any numerical field whose terms the user wants to enumerate over
865 Facet Contraint Counts for selected ranges.
866<P>
867<DL>
868<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE">Constant Field Values</A></DL>
869</DL>
870<HR>
871
872<A NAME="FACET_RANGE_START"><!-- --></A><H3>
873FACET_RANGE_START</H3>
874<PRE>
875static final <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> <B>FACET_RANGE_START</B></PRE>
876<DL>
877<DD>Number indicating the starting point for a numerical range facet.
878 Can be overriden on a per field basis.
879<P>
880<DL>
881<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE_START">Constant Field Values</A></DL>
882</DL>
883<HR>
884
885<A NAME="FACET_RANGE_END"><!-- --></A><H3>
886FACET_RANGE_END</H3>
887<PRE>
888static final <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> <B>FACET_RANGE_END</B></PRE>
889<DL>
890<DD>Number indicating the ending point for a numerical range facet.
891 Can be overriden on a per field basis.
892<P>
893<DL>
894<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE_END">Constant Field Values</A></DL>
895</DL>
896<HR>
897
898<A NAME="FACET_RANGE_GAP"><!-- --></A><H3>
899FACET_RANGE_GAP</H3>
900<PRE>
901static final <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> <B>FACET_RANGE_GAP</B></PRE>
902<DL>
903<DD>Number indicating the interval of sub-ranges for a numerical
904 facet range.
905 Can be overriden on a per field basis.
906<P>
907<DL>
908<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE_GAP">Constant Field Values</A></DL>
909</DL>
910<HR>
911
912<A NAME="FACET_RANGE_HARD_END"><!-- --></A><H3>
913FACET_RANGE_HARD_END</H3>
914<PRE>
915static final <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> <B>FACET_RANGE_HARD_END</B></PRE>
916<DL>
917<DD>Boolean indicating how counts should be computed if the range
918 between 'start' and 'end' is not evenly divisible by 'gap'.  If
919 this value is true, then all counts of ranges involving the 'end'
920 point will use the exact endpoint specified -- this includes the
921 'between' and 'after' counts as well as the last range computed
922 using the 'gap'.  If the value is false, then 'gap' is used to
923 compute the effective endpoint closest to the 'end' param which
924 results in the range between 'start' and 'end' being evenly
925 divisible by 'gap'.
926 The default is false.
927 Can be overriden on a per field basis.
928<P>
929<DL>
930<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE_HARD_END">Constant Field Values</A></DL>
931</DL>
932<HR>
933
934<A NAME="FACET_RANGE_OTHER"><!-- --></A><H3>
935FACET_RANGE_OTHER</H3>
936<PRE>
937static final <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> <B>FACET_RANGE_OTHER</B></PRE>
938<DL>
939<DD>String indicating what "other" ranges should be computed for a
940 numerical range facet (multi-value).
941 Can be overriden on a per field basis.
942<P>
943<DL>
944<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE_OTHER">Constant Field Values</A></DL>
945</DL>
946<HR>
947
948<A NAME="FACET_RANGE_INCLUDE"><!-- --></A><H3>
949FACET_RANGE_INCLUDE</H3>
950<PRE>
951static final <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> <B>FACET_RANGE_INCLUDE</B></PRE>
952<DL>
953<DD><p>
954 Multivalued string indicating what rules should be applied to determine
955 when the the ranges generated for numeric faceting should be inclusive or
956 exclusive of their end points.
957 </p>
958 <p>
959 The default value if none are specified is: lower
960 </p>
961 <p>
962 Can be overriden on a per field basis.
963 </p>
964<P>
965<DL>
966<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeInclude.html" title="enum in org.apache.solr.common.params"><CODE>FacetParams.FacetRangeInclude</CODE></A>,
967<A HREF="../../../../../constant-values.html#org.apache.solr.common.params.FacetParams.FACET_RANGE_INCLUDE">Constant Field Values</A></DL>
968</DL>
969<!-- ========= END OF CLASS DATA ========= -->
970<HR>
971
972
973<!-- ======= START OF BOTTOM NAVBAR ====== -->
974<A NAME="navbar_bottom"><!-- --></A>
975<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
976<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
977<TR>
978<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
979<A NAME="navbar_bottom_firstrow"><!-- --></A>
980<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
981  <TR ALIGN="center" VALIGN="top">
982  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
983  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
984  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
985  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FacetParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
986  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
987  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
988  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
989  </TR>
990</TABLE>
991</TD>
992<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
993</EM>
994</TD>
995</TR>
996
997<TR>
998<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
999&nbsp;<A HREF="../../../../../org/apache/solr/common/params/EventParams.html" title="interface in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
1000&nbsp;<A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetDateOther.html" title="enum in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
1001<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1002  <A HREF="../../../../../index.html?org/apache/solr/common/params/FacetParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1003&nbsp;<A HREF="FacetParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1004&nbsp;<SCRIPT type="text/javascript">
1005  <!--
1006  if(window==top) {
1007    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1008  }
1009  //-->
1010</SCRIPT>
1011<NOSCRIPT>
1012  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1013</NOSCRIPT>
1014
1015
1016</FONT></TD>
1017</TR>
1018<TR>
1019<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1020  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
1021<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1022DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
1023</TR>
1024</TABLE>
1025<A NAME="skip-navbar_bottom"></A>
1026<!-- ======== END OF BOTTOM NAVBAR ======= -->
1027
1028<HR>
1029
1030          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
1031          <script src='../../../../../prettify.js' type='text/javascript'></script>
1032          <script type='text/javascript'>
1033            (function(){
1034              var oldonload = window.onload;
1035              if (typeof oldonload != 'function') {
1036                window.onload = prettyPrint;
1037              } else {
1038                window.onload = function() {
1039                  oldonload();
1040                  prettyPrint();
1041                }
1042              }
1043            })();
1044          </script>
1045       
1046</BODY>
1047</HTML>
Note: See TracBrowser for help on using the repository browser.