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

Revision 7588, 50.0 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>
8CommonParams (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="CommonParams (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/CommonParams.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/AppendedSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/common/params/CommonParams.EchoParamStyle.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/CommonParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="CommonParams.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 CommonParams</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>CommonParams</B></DL>
97</PRE>
98
99<P>
100Parameters used across many handlers
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/CommonParams.EchoParamStyle.html" title="enum in org.apache.solr.common.params">CommonParams.EchoParamStyle</A></B></CODE>
119
120<BR>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;valid values for: <code>echoParams</code></TD>
122</TR>
123</TABLE>
124&nbsp;<!-- =========== FIELD SUMMARY =========== -->
125
126<A NAME="field_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
130<B>Field Summary</B></FONT></TH>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<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>
135<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#CACHE">CACHE</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used as a local parameter on queries.</TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<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>
143<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#COST">COST</A></B></CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used as a local param on filter queries in conjunction with cache=false.</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<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>
151<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG">DEBUG</A></B></CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether to provide debug info for specific items.</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<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>
159<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG_QUERY">DEBUG_QUERY</A></B></CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;whether to include debug data for all components pieces, including doing explains</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<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>
167<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DF">DF</A></B></CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;default query field</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<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>
175<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#EXCLUDE">EXCLUDE</A></B></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>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>
183<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#EXPLAIN_OTHER">EXPLAIN_OTHER</A></B></CODE>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;another query to explain against</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<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>
191<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#EXPLAIN_STRUCT">EXPLAIN_STRUCT</A></B></CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;boolean indicating whether score explanations should structured (true),
195 or plain text (false)</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<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>
200<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#FALSE">FALSE</A></B></CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<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>
208<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#FIELD">FIELD</A></B></CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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/CommonParams.html#FL">FL</A></B></CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;query and init param for field list</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<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>
224<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#FQ">FQ</A></B></CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Lucene query string(s) for filtering the results without affecting scoring</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<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>
232<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#HEADER_ECHO_HANDLER">HEADER_ECHO_HANDLER</A></B></CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'true' if the header should include the handler name</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<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>
240<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#HEADER_ECHO_PARAMS">HEADER_ECHO_PARAMS</A></B></CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;include the parameters in the header</TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247<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>
248<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#NOW">NOW</A></B></CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override for the concept of "NOW" to be used throughout this request,
252 expressed as milliseconds since epoch.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<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>
257<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#OMIT_HEADER">OMIT_HEADER</A></B></CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;include header in the response</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<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>
265<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#OUTPUT_KEY">OUTPUT_KEY</A></B></CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<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>
273<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#PAGEDOC">PAGEDOC</A></B></CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;docid of the last document of the previous page</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<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>
281<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#PAGESCORE">PAGESCORE</A></B></CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;score of the last document of the previous page</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<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>
289<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#Q">Q</A></B></CODE>
290
291<BR>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;query string</TD>
293</TR>
294<TR BGCOLOR="white" CLASS="TableRowColor">
295<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296<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>
297<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#QT">QT</A></B></CODE>
298
299<BR>
300&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the Request Handler (formerly known as the Query Type) - which Request Handler should handle the request</TD>
301</TR>
302<TR BGCOLOR="white" CLASS="TableRowColor">
303<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304<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>
305<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#QUERY">QUERY</A></B></CODE>
306
307<BR>
308&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG"><CODE>DEBUG</CODE></A> value indicating an interest in debug output related to the Query (parsing, etc.)</TD>
309</TR>
310<TR BGCOLOR="white" CLASS="TableRowColor">
311<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312<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>
313<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#RESULTS">RESULTS</A></B></CODE>
314
315<BR>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG"><CODE>DEBUG</CODE></A> value indicating an interest in debug output related to the results (explains)</TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320<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>
321<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#ROWS">ROWS</A></B></CODE>
322
323<BR>
324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;number of documents to return starting at "start"</TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328<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>
329<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#SORT">SORT</A></B></CODE>
330
331<BR>
332&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sort order</TD>
333</TR>
334<TR BGCOLOR="white" CLASS="TableRowColor">
335<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336<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>
337<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#START">START</A></B></CODE>
338
339<BR>
340&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;zero based offset of matching documents to retrieve</TD>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344<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>
345<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#STREAM_BODY">STREAM_BODY</A></B></CODE>
346
347<BR>
348&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the content stream should come directly from a field</TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352<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>
353<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#STREAM_CONTENTTYPE">STREAM_CONTENTTYPE</A></B></CODE>
354
355<BR>
356&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Explicitly set the content type for the input stream
357 If multiple streams are specified, the explicit contentType
358 will be used for all of them.</TD>
359</TR>
360<TR BGCOLOR="white" CLASS="TableRowColor">
361<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
362<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>
363<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#STREAM_FILE">STREAM_FILE</A></B></CODE>
364
365<BR>
366&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the content stream should come from a File (using FileReader)</TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370<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>
371<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#STREAM_URL">STREAM_URL</A></B></CODE>
372
373<BR>
374&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the content stream should come from a URL (using URLConnection)</TD>
375</TR>
376<TR BGCOLOR="white" CLASS="TableRowColor">
377<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378<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>
379<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TAG">TAG</A></B></CODE>
380
381<BR>
382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<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>
387<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TERMS">TERMS</A></B></CODE>
388
389<BR>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
391</TR>
392<TR BGCOLOR="white" CLASS="TableRowColor">
393<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394<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>
395<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#THREADS">THREADS</A></B></CODE>
396
397<BR>
398&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
399</TR>
400<TR BGCOLOR="white" CLASS="TableRowColor">
401<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402<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>
403<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TIME_ALLOWED">TIME_ALLOWED</A></B></CODE>
404
405<BR>
406&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Timeout value in milliseconds.</TD>
407</TR>
408<TR BGCOLOR="white" CLASS="TableRowColor">
409<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410<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>
411<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TIMING">TIMING</A></B></CODE>
412
413<BR>
414&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG"><CODE>DEBUG</CODE></A> value indicating an interest in debug output related to timing</TD>
415</TR>
416<TR BGCOLOR="white" CLASS="TableRowColor">
417<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
418<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>
419<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TR">TR</A></B></CODE>
420
421<BR>
422&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transformer param -- used with XSLT</TD>
423</TR>
424<TR BGCOLOR="white" CLASS="TableRowColor">
425<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
426<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>
427<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TRUE">TRUE</A></B></CODE>
428
429<BR>
430&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
431</TR>
432<TR BGCOLOR="white" CLASS="TableRowColor">
433<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
434<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>
435<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#TZ">TZ</A></B></CODE>
436
437<BR>
438&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies the TimeZone used by the client for the purposes of
439 any DateMath rounding that may take place when executing the request</TD>
440</TR>
441<TR BGCOLOR="white" CLASS="TableRowColor">
442<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
443<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>
444<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#VALUE">VALUE</A></B></CODE>
445
446<BR>
447&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
448</TR>
449<TR BGCOLOR="white" CLASS="TableRowColor">
450<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
451<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>
452<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#VERSION">VERSION</A></B></CODE>
453
454<BR>
455&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;version parameter to check request-response compatibility</TD>
456</TR>
457<TR BGCOLOR="white" CLASS="TableRowColor">
458<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
459<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>
460<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#WT">WT</A></B></CODE>
461
462<BR>
463&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the response writer type - the format of the response</TD>
464</TR>
465<TR BGCOLOR="white" CLASS="TableRowColor">
466<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
467<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>
468<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#XSL">XSL</A></B></CODE>
469
470<BR>
471&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;stylesheet to apply to XML results</TD>
472</TR>
473</TABLE>
474&nbsp;
475<P>
476
477<!-- ============ FIELD DETAIL =========== -->
478
479<A NAME="field_detail"><!-- --></A>
480<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
481<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
482<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
483<B>Field Detail</B></FONT></TH>
484</TR>
485</TABLE>
486
487<A NAME="NOW"><!-- --></A><H3>
488NOW</H3>
489<PRE>
490static 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>NOW</B></PRE>
491<DL>
492<DD>Override for the concept of "NOW" to be used throughout this request,
493 expressed as milliseconds since epoch.  This is primarily used in
494 distributed search to ensure consistent time values are used across
495 multiple sub-requests.
496<P>
497<DL>
498<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.NOW">Constant Field Values</A></DL>
499</DL>
500<HR>
501
502<A NAME="TZ"><!-- --></A><H3>
503TZ</H3>
504<PRE>
505static 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>TZ</B></PRE>
506<DL>
507<DD>Specifies the TimeZone used by the client for the purposes of
508 any DateMath rounding that may take place when executing the request
509<P>
510<DL>
511<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.TZ">Constant Field Values</A></DL>
512</DL>
513<HR>
514
515<A NAME="QT"><!-- --></A><H3>
516QT</H3>
517<PRE>
518static 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>QT</B></PRE>
519<DL>
520<DD>the Request Handler (formerly known as the Query Type) - which Request Handler should handle the request
521<P>
522<DL>
523<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.QT">Constant Field Values</A></DL>
524</DL>
525<HR>
526
527<A NAME="WT"><!-- --></A><H3>
528WT</H3>
529<PRE>
530static 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>WT</B></PRE>
531<DL>
532<DD>the response writer type - the format of the response
533<P>
534<DL>
535<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.WT">Constant Field Values</A></DL>
536</DL>
537<HR>
538
539<A NAME="Q"><!-- --></A><H3>
540Q</H3>
541<PRE>
542static 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>Q</B></PRE>
543<DL>
544<DD>query string
545<P>
546<DL>
547<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.Q">Constant Field Values</A></DL>
548</DL>
549<HR>
550
551<A NAME="SORT"><!-- --></A><H3>
552SORT</H3>
553<PRE>
554static 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>SORT</B></PRE>
555<DL>
556<DD>sort order
557<P>
558<DL>
559<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.SORT">Constant Field Values</A></DL>
560</DL>
561<HR>
562
563<A NAME="FQ"><!-- --></A><H3>
564FQ</H3>
565<PRE>
566static 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>FQ</B></PRE>
567<DL>
568<DD>Lucene query string(s) for filtering the results without affecting scoring
569<P>
570<DL>
571<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.FQ">Constant Field Values</A></DL>
572</DL>
573<HR>
574
575<A NAME="START"><!-- --></A><H3>
576START</H3>
577<PRE>
578static 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>START</B></PRE>
579<DL>
580<DD>zero based offset of matching documents to retrieve
581<P>
582<DL>
583<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.START">Constant Field Values</A></DL>
584</DL>
585<HR>
586
587<A NAME="ROWS"><!-- --></A><H3>
588ROWS</H3>
589<PRE>
590static 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>ROWS</B></PRE>
591<DL>
592<DD>number of documents to return starting at "start"
593<P>
594<DL>
595<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.ROWS">Constant Field Values</A></DL>
596</DL>
597<HR>
598
599<A NAME="PAGESCORE"><!-- --></A><H3>
600PAGESCORE</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>PAGESCORE</B></PRE>
603<DL>
604<DD>score of the last document of the previous page
605<P>
606<DL>
607<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.PAGESCORE">Constant Field Values</A></DL>
608</DL>
609<HR>
610
611<A NAME="PAGEDOC"><!-- --></A><H3>
612PAGEDOC</H3>
613<PRE>
614static 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>PAGEDOC</B></PRE>
615<DL>
616<DD>docid of the last document of the previous page
617<P>
618<DL>
619<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.PAGEDOC">Constant Field Values</A></DL>
620</DL>
621<HR>
622
623<A NAME="XSL"><!-- --></A><H3>
624XSL</H3>
625<PRE>
626static 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>XSL</B></PRE>
627<DL>
628<DD>stylesheet to apply to XML results
629<P>
630<DL>
631<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.XSL">Constant Field Values</A></DL>
632</DL>
633<HR>
634
635<A NAME="VERSION"><!-- --></A><H3>
636VERSION</H3>
637<PRE>
638static 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>VERSION</B></PRE>
639<DL>
640<DD>version parameter to check request-response compatibility
641<P>
642<DL>
643<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.VERSION">Constant Field Values</A></DL>
644</DL>
645<HR>
646
647<A NAME="FL"><!-- --></A><H3>
648FL</H3>
649<PRE>
650static 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>FL</B></PRE>
651<DL>
652<DD>query and init param for field list
653<P>
654<DL>
655<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.FL">Constant Field Values</A></DL>
656</DL>
657<HR>
658
659<A NAME="DF"><!-- --></A><H3>
660DF</H3>
661<PRE>
662static 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>DF</B></PRE>
663<DL>
664<DD>default query field
665<P>
666<DL>
667<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.DF">Constant Field Values</A></DL>
668</DL>
669<HR>
670
671<A NAME="TR"><!-- --></A><H3>
672TR</H3>
673<PRE>
674static 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>TR</B></PRE>
675<DL>
676<DD>Transformer param -- used with XSLT
677<P>
678<DL>
679<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.TR">Constant Field Values</A></DL>
680</DL>
681<HR>
682
683<A NAME="DEBUG_QUERY"><!-- --></A><H3>
684DEBUG_QUERY</H3>
685<PRE>
686static 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>DEBUG_QUERY</B></PRE>
687<DL>
688<DD>whether to include debug data for all components pieces, including doing explains
689<P>
690<DL>
691<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.DEBUG_QUERY">Constant Field Values</A></DL>
692</DL>
693<HR>
694
695<A NAME="DEBUG"><!-- --></A><H3>
696DEBUG</H3>
697<PRE>
698static 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>DEBUG</B></PRE>
699<DL>
700<DD>Whether to provide debug info for specific items.
701<P>
702<DL>
703<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG_QUERY"><CODE>DEBUG_QUERY</CODE></A>,
704<A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.DEBUG">Constant Field Values</A></DL>
705</DL>
706<HR>
707
708<A NAME="TIMING"><!-- --></A><H3>
709TIMING</H3>
710<PRE>
711static 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>TIMING</B></PRE>
712<DL>
713<DD><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG"><CODE>DEBUG</CODE></A> value indicating an interest in debug output related to timing
714<P>
715<DL>
716<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.TIMING">Constant Field Values</A></DL>
717</DL>
718<HR>
719
720<A NAME="RESULTS"><!-- --></A><H3>
721RESULTS</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>RESULTS</B></PRE>
724<DL>
725<DD><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG"><CODE>DEBUG</CODE></A> value indicating an interest in debug output related to the results (explains)
726<P>
727<DL>
728<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.RESULTS">Constant Field Values</A></DL>
729</DL>
730<HR>
731
732<A NAME="QUERY"><!-- --></A><H3>
733QUERY</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>QUERY</B></PRE>
736<DL>
737<DD><A HREF="../../../../../org/apache/solr/common/params/CommonParams.html#DEBUG"><CODE>DEBUG</CODE></A> value indicating an interest in debug output related to the Query (parsing, etc.)
738<P>
739<DL>
740<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.QUERY">Constant Field Values</A></DL>
741</DL>
742<HR>
743
744<A NAME="EXPLAIN_STRUCT"><!-- --></A><H3>
745EXPLAIN_STRUCT</H3>
746<PRE>
747static 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>EXPLAIN_STRUCT</B></PRE>
748<DL>
749<DD>boolean indicating whether score explanations should structured (true),
750 or plain text (false)
751<P>
752<DL>
753<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.EXPLAIN_STRUCT">Constant Field Values</A></DL>
754</DL>
755<HR>
756
757<A NAME="EXPLAIN_OTHER"><!-- --></A><H3>
758EXPLAIN_OTHER</H3>
759<PRE>
760static 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>EXPLAIN_OTHER</B></PRE>
761<DL>
762<DD>another query to explain against
763<P>
764<DL>
765<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.EXPLAIN_OTHER">Constant Field Values</A></DL>
766</DL>
767<HR>
768
769<A NAME="STREAM_URL"><!-- --></A><H3>
770STREAM_URL</H3>
771<PRE>
772static 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>STREAM_URL</B></PRE>
773<DL>
774<DD>If the content stream should come from a URL (using URLConnection)
775<P>
776<DL>
777<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.STREAM_URL">Constant Field Values</A></DL>
778</DL>
779<HR>
780
781<A NAME="STREAM_FILE"><!-- --></A><H3>
782STREAM_FILE</H3>
783<PRE>
784static 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>STREAM_FILE</B></PRE>
785<DL>
786<DD>If the content stream should come from a File (using FileReader)
787<P>
788<DL>
789<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.STREAM_FILE">Constant Field Values</A></DL>
790</DL>
791<HR>
792
793<A NAME="STREAM_BODY"><!-- --></A><H3>
794STREAM_BODY</H3>
795<PRE>
796static 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>STREAM_BODY</B></PRE>
797<DL>
798<DD>If the content stream should come directly from a field
799<P>
800<DL>
801<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.STREAM_BODY">Constant Field Values</A></DL>
802</DL>
803<HR>
804
805<A NAME="STREAM_CONTENTTYPE"><!-- --></A><H3>
806STREAM_CONTENTTYPE</H3>
807<PRE>
808static 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>STREAM_CONTENTTYPE</B></PRE>
809<DL>
810<DD>Explicitly set the content type for the input stream
811 If multiple streams are specified, the explicit contentType
812 will be used for all of them.
813<P>
814<DL>
815<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.STREAM_CONTENTTYPE">Constant Field Values</A></DL>
816</DL>
817<HR>
818
819<A NAME="TIME_ALLOWED"><!-- --></A><H3>
820TIME_ALLOWED</H3>
821<PRE>
822static 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>TIME_ALLOWED</B></PRE>
823<DL>
824<DD>Timeout value in milliseconds.  If not set, or the value is <= 0, there is no timeout.
825<P>
826<DL>
827<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.TIME_ALLOWED">Constant Field Values</A></DL>
828</DL>
829<HR>
830
831<A NAME="HEADER_ECHO_HANDLER"><!-- --></A><H3>
832HEADER_ECHO_HANDLER</H3>
833<PRE>
834static 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>HEADER_ECHO_HANDLER</B></PRE>
835<DL>
836<DD>'true' if the header should include the handler name
837<P>
838<DL>
839<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.HEADER_ECHO_HANDLER">Constant Field Values</A></DL>
840</DL>
841<HR>
842
843<A NAME="HEADER_ECHO_PARAMS"><!-- --></A><H3>
844HEADER_ECHO_PARAMS</H3>
845<PRE>
846static 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>HEADER_ECHO_PARAMS</B></PRE>
847<DL>
848<DD>include the parameters in the header
849<P>
850<DL>
851<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.HEADER_ECHO_PARAMS">Constant Field Values</A></DL>
852</DL>
853<HR>
854
855<A NAME="OMIT_HEADER"><!-- --></A><H3>
856OMIT_HEADER</H3>
857<PRE>
858static 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>OMIT_HEADER</B></PRE>
859<DL>
860<DD>include header in the response
861<P>
862<DL>
863<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.OMIT_HEADER">Constant Field Values</A></DL>
864</DL>
865<HR>
866
867<A NAME="EXCLUDE"><!-- --></A><H3>
868EXCLUDE</H3>
869<PRE>
870static 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>EXCLUDE</B></PRE>
871<DL>
872<DL>
873<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.EXCLUDE">Constant Field Values</A></DL>
874</DL>
875<HR>
876
877<A NAME="TAG"><!-- --></A><H3>
878TAG</H3>
879<PRE>
880static 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>TAG</B></PRE>
881<DL>
882<DL>
883<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.TAG">Constant Field Values</A></DL>
884</DL>
885<HR>
886
887<A NAME="TERMS"><!-- --></A><H3>
888TERMS</H3>
889<PRE>
890static 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>TERMS</B></PRE>
891<DL>
892<DL>
893<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.TERMS">Constant Field Values</A></DL>
894</DL>
895<HR>
896
897<A NAME="OUTPUT_KEY"><!-- --></A><H3>
898OUTPUT_KEY</H3>
899<PRE>
900static 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>OUTPUT_KEY</B></PRE>
901<DL>
902<DL>
903<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.OUTPUT_KEY">Constant Field Values</A></DL>
904</DL>
905<HR>
906
907<A NAME="FIELD"><!-- --></A><H3>
908FIELD</H3>
909<PRE>
910static 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>FIELD</B></PRE>
911<DL>
912<DL>
913<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.FIELD">Constant Field Values</A></DL>
914</DL>
915<HR>
916
917<A NAME="VALUE"><!-- --></A><H3>
918VALUE</H3>
919<PRE>
920static 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>VALUE</B></PRE>
921<DL>
922<DL>
923<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.VALUE">Constant Field Values</A></DL>
924</DL>
925<HR>
926
927<A NAME="THREADS"><!-- --></A><H3>
928THREADS</H3>
929<PRE>
930static 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>THREADS</B></PRE>
931<DL>
932<DL>
933<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.THREADS">Constant Field Values</A></DL>
934</DL>
935<HR>
936
937<A NAME="TRUE"><!-- --></A><H3>
938TRUE</H3>
939<PRE>
940static 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>TRUE</B></PRE>
941<DL>
942<DL>
943</DL>
944</DL>
945<HR>
946
947<A NAME="FALSE"><!-- --></A><H3>
948FALSE</H3>
949<PRE>
950static 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>FALSE</B></PRE>
951<DL>
952<DL>
953</DL>
954</DL>
955<HR>
956
957<A NAME="CACHE"><!-- --></A><H3>
958CACHE</H3>
959<PRE>
960static 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>CACHE</B></PRE>
961<DL>
962<DD>Used as a local parameter on queries.  cache=false means don't check any query or filter caches.
963 cache=true is the default.
964<P>
965<DL>
966<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.CACHE">Constant Field Values</A></DL>
967</DL>
968<HR>
969
970<A NAME="COST"><!-- --></A><H3>
971COST</H3>
972<PRE>
973static 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>COST</B></PRE>
974<DL>
975<DD>Used as a local param on filter queries in conjunction with cache=false.  Filters are checked in order, from
976 smallest cost to largest. If cost>=100 and the query implements PostFilter, then that interface will be used to do post query filtering.
977<P>
978<DL>
979<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.CommonParams.COST">Constant Field Values</A></DL>
980</DL>
981<!-- ========= END OF CLASS DATA ========= -->
982<HR>
983
984
985<!-- ======= START OF BOTTOM NAVBAR ====== -->
986<A NAME="navbar_bottom"><!-- --></A>
987<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
988<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
989<TR>
990<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
991<A NAME="navbar_bottom_firstrow"><!-- --></A>
992<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
993  <TR ALIGN="center" VALIGN="top">
994  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
995  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
996  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
997  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CommonParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
998  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
999  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1000  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1001  </TR>
1002</TABLE>
1003</TD>
1004<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1005</EM>
1006</TD>
1007</TR>
1008
1009<TR>
1010<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1011&nbsp;<A HREF="../../../../../org/apache/solr/common/params/AppendedSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
1012&nbsp;<A HREF="../../../../../org/apache/solr/common/params/CommonParams.EchoParamStyle.html" title="enum in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
1013<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1014  <A HREF="../../../../../index.html?org/apache/solr/common/params/CommonParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1015&nbsp;<A HREF="CommonParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1016&nbsp;<SCRIPT type="text/javascript">
1017  <!--
1018  if(window==top) {
1019    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1020  }
1021  //-->
1022</SCRIPT>
1023<NOSCRIPT>
1024  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1025</NOSCRIPT>
1026
1027
1028</FONT></TD>
1029</TR>
1030<TR>
1031<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1032  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>
1033<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1034DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
1035</TR>
1036</TABLE>
1037<A NAME="skip-navbar_bottom"></A>
1038<!-- ======== END OF BOTTOM NAVBAR ======= -->
1039
1040<HR>
1041
1042          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
1043          <script src='../../../../../prettify.js' type='text/javascript'></script>
1044          <script type='text/javascript'>
1045            (function(){
1046              var oldonload = window.onload;
1047              if (typeof oldonload != 'function') {
1048                window.onload = prettyPrint;
1049              } else {
1050                window.onload = function() {
1051                  oldonload();
1052                  prettyPrint();
1053                }
1054              }
1055            })();
1056          </script>
1057       
1058</BODY>
1059</HTML>
Note: See TracBrowser for help on using the repository browser.