source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/util/SolrPluginUtils.html @ 7588

Revision 7588, 64.9 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>
8SolrPluginUtils (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="SolrPluginUtils (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/SolrPluginUtils.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/util/SimplePostTool.html" title="class in org.apache.solr.util"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/util/SolrPluginUtils.DisjunctionMaxQueryParser.html" title="class in org.apache.solr.util"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/util/SolrPluginUtils.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SolrPluginUtils.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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.solr.util</FONT>
92<BR>
93Class SolrPluginUtils</H2>
94<PRE>
95<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.util.SolrPluginUtils</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>SolrPluginUtils</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
101</PRE>
102
103<P>
104<p>Utilities that may be of use to RequestHandlers.</p>
105
106 <p>
107 Many of these functions have code that was stolen/mutated from
108 StandardRequestHandler.
109 </p>
110
111 <p>:TODO: refactor StandardRequestHandler to use these utilities</p>
112
113 <p>:TODO: Many "standard" functionality methods are not cognisant of
114 default parameter settings.
115<P>
116
117<P>
118<HR>
119
120<P>
121<!-- ======== NESTED CLASS SUMMARY ======== -->
122
123<A NAME="nested_class_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127<B>Nested Class Summary</B></FONT></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>static&nbsp;class</CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.DisjunctionMaxQueryParser.html" title="class in org.apache.solr.util">SolrPluginUtils.DisjunctionMaxQueryParser</A></B></CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A subclass of SolrQueryParser that supports aliasing fields for
136 constructing DisjunctionMaxQueries.</TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>static&nbsp;class</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.IdentityRegenerator.html" title="class in org.apache.solr.util">SolrPluginUtils.IdentityRegenerator</A></B></CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A CacheRegenerator that can be used whenever the items in the cache
145 are not dependant on the current searcher.</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ======== CONSTRUCTOR SUMMARY ======== -->
150
151<A NAME="constructor_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
155<B>Constructor Summary</B></FONT></TH>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#SolrPluginUtils()">SolrPluginUtils</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ========== METHOD SUMMARY =========== -->
166
167<A NAME="method_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
171<B>Method Summary</B></FONT></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>static&nbsp;<A HREF="../../../../org/apache/solr/common/SolrDocumentList.html" title="class in org.apache.solr.common">SolrDocumentList</A></CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#docListToSolrDocumentList(org.apache.solr.search.DocList, org.apache.solr.search.SolrIndexSearcher, java.util.Set, java.util.Map)">docListToSolrDocumentList</A></B>(<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
177                          <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
178                          <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;fields,
179                          <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common">SolrDocument</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&gt;&nbsp;ids)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert a DocList to a SolrDocumentList
183
184 The optional param "ids" is populated with the lucene document id
185 for each SolrDocument.</TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>static&nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#doSimpleQuery(java.lang.String, org.apache.solr.request.SolrQueryRequest, int, int)">doSimpleQuery</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;sreq,
191              <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
192              int&nbsp;start,
193              int&nbsp;limit)</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes a basic query</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>static&nbsp;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#doStandardDebug(org.apache.solr.request.SolrQueryRequest, java.lang.String, org.apache.lucene.search.Query, org.apache.solr.search.DocList, boolean, boolean)">doStandardDebug</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
202                <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;userQuery,
203                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
204                <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;results,
205                boolean&nbsp;dbgQuery,
206                boolean&nbsp;dbgResults)</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210 Returns a NamedList containing many "standard" pieces of debugging
211 information.</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="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt;&gt;</CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#explanationsToNamedLists(org.apache.solr.common.util.NamedList)">explanationsToNamedLists</A></B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Explanation.html?is-external=true" title="class or interface in org.apache.lucene.search">Explanation</A>&gt;&nbsp;explanations)</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt;</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#explanationToNamedList(org.apache.lucene.search.Explanation)">explanationToNamedList</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Explanation.html?is-external=true" title="class or interface in org.apache.lucene.search">Explanation</A>&nbsp;e)</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>static&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#flattenBooleanQuery(org.apache.lucene.search.BooleanQuery, org.apache.lucene.search.BooleanQuery)">flattenBooleanQuery</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/BooleanQuery.html?is-external=true" title="class or interface in org.apache.lucene.search">BooleanQuery</A>&nbsp;to,
233                    <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/BooleanQuery.html?is-external=true" title="class or interface in org.apache.lucene.search">BooleanQuery</A>&nbsp;from)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Recursively walks the "from" query pulling out sub-queries and
237 adding them to the "to" query.</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/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#getDebugInterests(java.lang.String[], org.apache.solr.handler.component.ResponseBuilder)">getDebugInterests</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;params,
243                  <A HREF="../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Explanation.html?is-external=true" title="class or interface in org.apache.lucene.search">Explanation</A>&gt;</CODE></FONT></TD>
251<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#getExplanations(org.apache.lucene.search.Query, org.apache.solr.search.DocList, org.apache.solr.search.SolrIndexSearcher, org.apache.solr.schema.IndexSchema)">getExplanations</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
252                <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
253                <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
254                <A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates an NamedList of Explanations for each item in a list of docs.</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>static&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A></CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#getSort(org.apache.solr.request.SolrQueryRequest)">getSort</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines the correct Sort based on the request parameter "sort"</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>static&nbsp;void</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#invokeSetters(java.lang.Object, org.apache.solr.common.util.NamedList)">invokeSetters</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;bean,
271              <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;initArgs)</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>static&nbsp;int</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#numDocs(org.apache.solr.search.SolrIndexSearcher, org.apache.lucene.search.Query, org.apache.lucene.search.Query)">numDocs</A></B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;s,
280        <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;q,
281        <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;f)</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;SolrIndexSearch.numDocs(Query,Query) freaks out if the filtering
285 query is null, so we use this workarround.</TD>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289<CODE>static&nbsp;void</CODE></FONT></TD>
290<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#optimizePreFetchDocs(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.DocList, org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">optimizePreFetchDocs</A></B>(<A HREF="../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
291                     <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
292                     <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
293                     <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
294                     <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;res)</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pre-fetch documents into the index searcher's document cache.</TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>&gt;</CODE></FONT></TD>
302<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#parseFieldBoosts(java.lang.String)">parseFieldBoosts</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;in)</CODE>
303
304<BR>
305&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a string containing fieldNames and boost info,
306 converts it to a Map from field name to boost info.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>&gt;</CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#parseFieldBoosts(java.lang.String[])">parseFieldBoosts</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;fieldLists)</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Like <code>parseFieldBoosts(String)</code>, but parses all the strings
315 in the provided array (which may be null).</TD>
316</TR>
317<TR BGCOLOR="white" CLASS="TableRowColor">
318<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/apache/solr/search/FieldParams.html" title="class in org.apache.solr.search">FieldParams</A>&gt;</CODE></FONT></TD>
320<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#parseFieldBoostsAndSlop(java.lang.String[], int, int)">parseFieldBoostsAndSlop</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;fieldLists,
321                        int&nbsp;wordGrams,
322                        int&nbsp;defaultSlop)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/**
326 Like <A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#parseFieldBoosts(java.lang.String)"><CODE>parseFieldBoosts(java.lang.String)</CODE></A>, but allows for an optional slop value prefixed by "~".</TD>
327</TR>
328<TR BGCOLOR="white" CLASS="TableRowColor">
329<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
330<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&gt;</CODE></FONT></TD>
331<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#parseQueryStrings(org.apache.solr.request.SolrQueryRequest, java.lang.String[])">parseQueryStrings</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
332                  <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;queries)</CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Turns an array of query strings into a List of Query objects.</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#partialEscape(java.lang.CharSequence)">partialEscape</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;s)</CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Escapes all special characters except '"', '-', and '+'</TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>static&nbsp;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
348<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#removeNulls(org.apache.solr.common.util.NamedList)">removeNulls</A></B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;nl)</CODE>
349
350<BR>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
352</TR>
353<TR BGCOLOR="white" CLASS="TableRowColor">
354<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355<CODE>static&nbsp;void</CODE></FONT></TD>
356<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)">setDefaults</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
357            <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;defaults,
358            <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;appends,
359            <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;invariants)</CODE>
360
361<BR>
362&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set default-ish params on a SolrQueryRequest.</TD>
363</TR>
364<TR BGCOLOR="white" CLASS="TableRowColor">
365<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
366<CODE>static&nbsp;void</CODE></FONT></TD>
367<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#setMinShouldMatch(org.apache.lucene.search.BooleanQuery, java.lang.String)">setMinShouldMatch</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/BooleanQuery.html?is-external=true" title="class or interface in org.apache.lucene.search">BooleanQuery</A>&nbsp;q,
368                  <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;spec)</CODE>
369
370<BR>
371&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the number of optional clauses in the query, and compares it
372 with the specification string to determine the proper value to use.</TD>
373</TR>
374<TR BGCOLOR="white" CLASS="TableRowColor">
375<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
376<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>
377<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#split(java.lang.String)">split</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;value)</CODE>
378
379<BR>
380&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Split a value that may contain a comma, space of bar separated list.</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/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
385<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#stripIllegalOperators(java.lang.CharSequence)">stripIllegalOperators</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;s)</CODE>
386
387<BR>
388&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Strips operators that are used illegally, otherwise reuturns it's
389 input.</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/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD>
394<TD><CODE><B><A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#stripUnbalancedQuotes(java.lang.CharSequence)">stripUnbalancedQuotes</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;s)</CODE>
395
396<BR>
397&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns it's input if there is an even (ie: balanced) number of
398 '"' characters -- otherwise returns a String in which all '"'
399 characters are striped out.</TD>
400</TR>
401</TABLE>
402&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
403<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
404<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
405<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
406</TR>
407<TR BGCOLOR="white" CLASS="TableRowColor">
408<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
409</TR>
410</TABLE>
411&nbsp;
412<P>
413
414<!-- ========= CONSTRUCTOR DETAIL ======== -->
415
416<A NAME="constructor_detail"><!-- --></A>
417<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
418<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
419<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
420<B>Constructor Detail</B></FONT></TH>
421</TR>
422</TABLE>
423
424<A NAME="SolrPluginUtils()"><!-- --></A><H3>
425SolrPluginUtils</H3>
426<PRE>
427public <B>SolrPluginUtils</B>()</PRE>
428<DL>
429</DL>
430
431<!-- ============ METHOD DETAIL ========== -->
432
433<A NAME="method_detail"><!-- --></A>
434<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
435<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
436<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
437<B>Method Detail</B></FONT></TH>
438</TR>
439</TABLE>
440
441<A NAME="setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
442setDefaults</H3>
443<PRE>
444public static void <B>setDefaults</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
445                               <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;defaults,
446                               <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;appends,
447                               <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;invariants)</PRE>
448<DL>
449<DD>Set default-ish params on a SolrQueryRequest.
450
451 RequestHandlers can use this method to ensure their defaults and
452 overrides are visible to other components such as the response writer
453<P>
454<DD><DL>
455<DT><B>Parameters:</B><DD><CODE>req</CODE> - The request whose params we are interested i<DD><CODE>defaults</CODE> - values to be used if no values are specified in the request params<DD><CODE>appends</CODE> - values to be appended to those from the request (or defaults) when dealing with multi-val params, or treated as another layer of defaults for singl-val params.<DD><CODE>invariants</CODE> - values which will be used instead of any request, or default values, regardless of context.</DL>
456</DD>
457</DL>
458<HR>
459
460<A NAME="numDocs(org.apache.solr.search.SolrIndexSearcher, org.apache.lucene.search.Query, org.apache.lucene.search.Query)"><!-- --></A><H3>
461numDocs</H3>
462<PRE>
463public static int <B>numDocs</B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;s,
464                          <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;q,
465                          <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;f)
466                   throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
467<DL>
468<DD>SolrIndexSearch.numDocs(Query,Query) freaks out if the filtering
469 query is null, so we use this workarround.
470<P>
471<DD><DL>
472
473<DT><B>Throws:</B>
474<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
475</DD>
476</DL>
477<HR>
478
479<A NAME="split(java.lang.String)"><!-- --></A><H3>
480split</H3>
481<PRE>
482public static <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>split</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
483<DL>
484<DD>Split a value that may contain a comma, space of bar separated list.
485<P>
486<DD><DL>
487</DL>
488</DD>
489</DL>
490<HR>
491
492<A NAME="optimizePreFetchDocs(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.DocList, org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
493optimizePreFetchDocs</H3>
494<PRE>
495public static void <B>optimizePreFetchDocs</B>(<A HREF="../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
496                                        <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
497                                        <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
498                                        <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
499                                        <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;res)
500                                 throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
501<DL>
502<DD>Pre-fetch documents into the index searcher's document cache.
503
504 This is an entirely optional step which you might want to perform for
505 the following reasons:
506
507 <ul>
508     <li>Locates the document-retrieval costs in one spot, which helps
509     detailed performance measurement</li>
510
511     <li>Determines a priori what fields will be needed to be fetched by
512     various subtasks, like response writing and highlighting.  This
513     minimizes the chance that many needed fields will be loaded lazily.
514     (it is more efficient to load all the field we require normally).</li>
515 </ul>
516
517 If lazy field loading is disabled, this method does nothing.
518<P>
519<DD><DL>
520
521<DT><B>Throws:</B>
522<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
523</DD>
524</DL>
525<HR>
526
527<A NAME="getDebugInterests(java.lang.String[], org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
528getDebugInterests</H3>
529<PRE>
530public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>getDebugInterests</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;params,
531                                            <A HREF="../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</PRE>
532<DL>
533<DD><DL>
534</DL>
535</DD>
536</DL>
537<HR>
538
539<A NAME="doStandardDebug(org.apache.solr.request.SolrQueryRequest, java.lang.String, org.apache.lucene.search.Query, org.apache.solr.search.DocList, boolean, boolean)"><!-- --></A><H3>
540doStandardDebug</H3>
541<PRE>
542public static <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>doStandardDebug</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
543                                        <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;userQuery,
544                                        <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
545                                        <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;results,
546                                        boolean&nbsp;dbgQuery,
547                                        boolean&nbsp;dbgResults)
548                                 throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
549<DL>
550<DD><p>
551 Returns a NamedList containing many "standard" pieces of debugging
552 information.
553 </p>
554
555 <ul>
556 <li>rawquerystring - the 'q' param exactly as specified by the client
557 </li>
558 <li>querystring - the 'q' param after any preprocessing done by the plugin
559 </li>
560 <li>parsedquery - the main query executed formated by the Solr
561     QueryParsing utils class (which knows about field types)
562 </li>
563 <li>parsedquery_toString - the main query executed formated by it's
564     own toString method (in case it has internal state Solr
565     doesn't know about)
566 </li>
567 <li>explain - the list of score explanations for each document in
568     results against query.
569 </li>
570 <li>otherQuery - the query string specified in 'explainOther' query param.
571 </li>
572 <li>explainOther - the list of score explanations for each document in
573     results against 'otherQuery'
574 </li>
575 </ul>
576<P>
577<DD><DL>
578<DT><B>Parameters:</B><DD><CODE>req</CODE> - the request we are dealing with<DD><CODE>userQuery</CODE> - the users query as a string, after any basic
579                  preprocessing has been done<DD><CODE>query</CODE> - the query built from the userQuery
580              (and perhaps other clauses) that identifies the main
581              result set of the response.<DD><CODE>results</CODE> - the main result set of the response
582<DT><B>Returns:</B><DD>The debug info
583<DT><B>Throws:</B>
584<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there was an IO error</DL>
585</DD>
586</DL>
587<HR>
588
589<A NAME="explanationToNamedList(org.apache.lucene.search.Explanation)"><!-- --></A><H3>
590explanationToNamedList</H3>
591<PRE>
592public static <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt; <B>explanationToNamedList</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Explanation.html?is-external=true" title="class or interface in org.apache.lucene.search">Explanation</A>&nbsp;e)</PRE>
593<DL>
594<DD><DL>
595</DL>
596</DD>
597</DL>
598<HR>
599
600<A NAME="explanationsToNamedLists(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
601explanationsToNamedLists</H3>
602<PRE>
603public static <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt;&gt; <B>explanationsToNamedLists</B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Explanation.html?is-external=true" title="class or interface in org.apache.lucene.search">Explanation</A>&gt;&nbsp;explanations)</PRE>
604<DL>
605<DD><DL>
606</DL>
607</DD>
608</DL>
609<HR>
610
611<A NAME="getExplanations(org.apache.lucene.search.Query, org.apache.solr.search.DocList, org.apache.solr.search.SolrIndexSearcher, org.apache.solr.schema.IndexSchema)"><!-- --></A><H3>
612getExplanations</H3>
613<PRE>
614public static <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Explanation.html?is-external=true" title="class or interface in org.apache.lucene.search">Explanation</A>&gt; <B>getExplanations</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
615                                                     <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
616                                                     <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
617                                                     <A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema)
618                                              throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
619<DL>
620<DD>Generates an NamedList of Explanations for each item in a list of docs.
621<P>
622<DD><DL>
623<DT><B>Parameters:</B><DD><CODE>query</CODE> - The Query you want explanations in the context of<DD><CODE>docs</CODE> - The Documents you want explained relative that query
624<DT><B>Throws:</B>
625<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
626</DD>
627</DL>
628<HR>
629
630<A NAME="doSimpleQuery(java.lang.String, org.apache.solr.request.SolrQueryRequest, int, int)"><!-- --></A><H3>
631doSimpleQuery</H3>
632<PRE>
633public static <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> <B>doSimpleQuery</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;sreq,
634                                    <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
635                                    int&nbsp;start,
636                                    int&nbsp;limit)
637                             throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
638<DL>
639<DD>Executes a basic query
640<P>
641<DD><DL>
642
643<DT><B>Throws:</B>
644<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
645</DD>
646</DL>
647<HR>
648
649<A NAME="parseFieldBoosts(java.lang.String)"><!-- --></A><H3>
650parseFieldBoosts</H3>
651<PRE>
652public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>&gt; <B>parseFieldBoosts</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;in)</PRE>
653<DL>
654<DD>Given a string containing fieldNames and boost info,
655 converts it to a Map from field name to boost info.
656
657 <p>
658 Doesn't care if boost info is negative, you're on your own.
659 </p>
660 <p>
661 Doesn't care if boost info is missing, again: you're on your own.
662 </p>
663<P>
664<DD><DL>
665<DT><B>Parameters:</B><DD><CODE>in</CODE> - a String like "fieldOne^2.3 fieldTwo fieldThree^-0.4"
666<DT><B>Returns:</B><DD>Map of fieldOne =&gt; 2.3, fieldTwo =&gt; null, fieldThree =&gt; -0.4</DL>
667</DD>
668</DL>
669<HR>
670
671<A NAME="parseFieldBoosts(java.lang.String[])"><!-- --></A><H3>
672parseFieldBoosts</H3>
673<PRE>
674public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</A>&gt; <B>parseFieldBoosts</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;fieldLists)</PRE>
675<DL>
676<DD>Like <code>parseFieldBoosts(String)</code>, but parses all the strings
677 in the provided array (which may be null).
678<P>
679<DD><DL>
680<DT><B>Parameters:</B><DD><CODE>fieldLists</CODE> - an array of Strings eg. <code>{"fieldOne^2.3", "fieldTwo", fieldThree^-0.4}</code>
681<DT><B>Returns:</B><DD>Map of fieldOne =&gt; 2.3, fieldTwo =&gt; null, fieldThree =&gt; -0.4</DL>
682</DD>
683</DL>
684<HR>
685
686<A NAME="parseFieldBoostsAndSlop(java.lang.String[], int, int)"><!-- --></A><H3>
687parseFieldBoostsAndSlop</H3>
688<PRE>
689public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/apache/solr/search/FieldParams.html" title="class in org.apache.solr.search">FieldParams</A>&gt; <B>parseFieldBoostsAndSlop</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;fieldLists,
690                                                        int&nbsp;wordGrams,
691                                                        int&nbsp;defaultSlop)</PRE>
692<DL>
693<DD>/**
694 Like <A HREF="../../../../org/apache/solr/util/SolrPluginUtils.html#parseFieldBoosts(java.lang.String)"><CODE>parseFieldBoosts(java.lang.String)</CODE></A>, but allows for an optional slop value prefixed by "~".
695<P>
696<DD><DL>
697<DT><B>Parameters:</B><DD><CODE>fieldLists</CODE> - - an array of Strings eg. <code>{"fieldOne^2.3", "fieldTwo", fieldThree~5^-0.4}</code><DD><CODE>wordGrams</CODE> - - (0=all words, 2,3 = shingle size)<DD><CODE>defaultSlop</CODE> - - the default slop for this param
698<DT><B>Returns:</B><DD>- FieldParams containing the fieldname,boost,slop,and shingle size</DL>
699</DD>
700</DL>
701<HR>
702
703<A NAME="setMinShouldMatch(org.apache.lucene.search.BooleanQuery, java.lang.String)"><!-- --></A><H3>
704setMinShouldMatch</H3>
705<PRE>
706public static void <B>setMinShouldMatch</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/BooleanQuery.html?is-external=true" title="class or interface in org.apache.lucene.search">BooleanQuery</A>&nbsp;q,
707                                     <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;spec)</PRE>
708<DL>
709<DD>Checks the number of optional clauses in the query, and compares it
710 with the specification string to determine the proper value to use.
711
712 <p>
713 Details about the specification format can be found
714 <a href="doc-files/min-should-match.html">here</a>
715 </p>
716
717 <p>A few important notes...</p>
718 <ul>
719 <li>
720 If the calculations based on the specification determine that no
721 optional clauses are needed, BooleanQuerysetMinMumberShouldMatch
722 will never be called, but the usual rules about BooleanQueries
723 still apply at search time (a BooleanQuery containing no required
724 clauses must still match at least one optional clause)
725 <li>
726 <li>
727 No matter what number the calculation arrives at,
728 BooleanQuery.setMinShouldMatch() will never be called with a
729 value greater then the number of optional clauses (or less then 1)
730 </li>
731 </ul>
732
733 <p>:TODO: should optimize the case where number is same
734 as clauses to just make them all "required"
735 </p>
736<P>
737<DD><DL>
738</DL>
739</DD>
740</DL>
741<HR>
742
743<A NAME="flattenBooleanQuery(org.apache.lucene.search.BooleanQuery, org.apache.lucene.search.BooleanQuery)"><!-- --></A><H3>
744flattenBooleanQuery</H3>
745<PRE>
746public static void <B>flattenBooleanQuery</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/BooleanQuery.html?is-external=true" title="class or interface in org.apache.lucene.search">BooleanQuery</A>&nbsp;to,
747                                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/BooleanQuery.html?is-external=true" title="class or interface in org.apache.lucene.search">BooleanQuery</A>&nbsp;from)</PRE>
748<DL>
749<DD>Recursively walks the "from" query pulling out sub-queries and
750 adding them to the "to" query.
751
752 <p>
753 Boosts are multiplied as needed.  Sub-BooleanQueryies which are not
754 optional will not be flattened.  From will be mangled durring the walk,
755 so do not attempt to reuse it.
756 </p>
757<P>
758<DD><DL>
759</DL>
760</DD>
761</DL>
762<HR>
763
764<A NAME="partialEscape(java.lang.CharSequence)"><!-- --></A><H3>
765partialEscape</H3>
766<PRE>
767public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>partialEscape</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;s)</PRE>
768<DL>
769<DD>Escapes all special characters except '"', '-', and '+'
770<P>
771<DD><DL>
772<DT><B>See Also:</B><DD><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queryparser/org/apache/lucene/queryparser/classic/QueryParserBase.html?is-external=true#escape(java.lang.String)" title="class or interface in org.apache.lucene.queryparser.classic"><CODE>QueryParserBase.escape(java.lang.String)</CODE></A></DL>
773</DD>
774</DL>
775<HR>
776
777<A NAME="stripIllegalOperators(java.lang.CharSequence)"><!-- --></A><H3>
778stripIllegalOperators</H3>
779<PRE>
780public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>stripIllegalOperators</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;s)</PRE>
781<DL>
782<DD>Strips operators that are used illegally, otherwise reuturns it's
783 input.  Some examples of illegal user queries are: "chocolate +-
784 chip", "chocolate - - chip", and "chocolate chip -".
785<P>
786<DD><DL>
787</DL>
788</DD>
789</DL>
790<HR>
791
792<A NAME="stripUnbalancedQuotes(java.lang.CharSequence)"><!-- --></A><H3>
793stripUnbalancedQuotes</H3>
794<PRE>
795public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>stripUnbalancedQuotes</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;s)</PRE>
796<DL>
797<DD>Returns it's input if there is an even (ie: balanced) number of
798 '"' characters -- otherwise returns a String in which all '"'
799 characters are striped out.
800<P>
801<DD><DL>
802</DL>
803</DD>
804</DL>
805<HR>
806
807<A NAME="removeNulls(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
808removeNulls</H3>
809<PRE>
810public static <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>removeNulls</B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;nl)</PRE>
811<DL>
812<DD><DL>
813</DL>
814</DD>
815</DL>
816<HR>
817
818<A NAME="getSort(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
819getSort</H3>
820<PRE>
821public static <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A> <B>getSort</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req)</PRE>
822<DL>
823<DD>Determines the correct Sort based on the request parameter "sort"
824<P>
825<DD><DL>
826
827<DT><B>Returns:</B><DD>null if no sort is specified.</DL>
828</DD>
829</DL>
830<HR>
831
832<A NAME="parseQueryStrings(org.apache.solr.request.SolrQueryRequest, java.lang.String[])"><!-- --></A><H3>
833parseQueryStrings</H3>
834<PRE>
835public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&gt; <B>parseQueryStrings</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
836                                            <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;queries)
837                                     throws <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queryparser/org/apache/lucene/queryparser/classic/ParseException.html?is-external=true" title="class or interface in org.apache.lucene.queryparser.classic">ParseException</A></PRE>
838<DL>
839<DD>Turns an array of query strings into a List of Query objects.
840<P>
841<DD><DL>
842
843<DT><B>Returns:</B><DD>null if no queries are generated
844<DT><B>Throws:</B>
845<DD><CODE><A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queryparser/org/apache/lucene/queryparser/classic/ParseException.html?is-external=true" title="class or interface in org.apache.lucene.queryparser.classic">ParseException</A></CODE></DL>
846</DD>
847</DL>
848<HR>
849
850<A NAME="docListToSolrDocumentList(org.apache.solr.search.DocList, org.apache.solr.search.SolrIndexSearcher, java.util.Set, java.util.Map)"><!-- --></A><H3>
851docListToSolrDocumentList</H3>
852<PRE>
853public static <A HREF="../../../../org/apache/solr/common/SolrDocumentList.html" title="class in org.apache.solr.common">SolrDocumentList</A> <B>docListToSolrDocumentList</B>(<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
854                                                         <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
855                                                         <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;fields,
856                                                         <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common">SolrDocument</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&gt;&nbsp;ids)
857                                                  throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
858<DL>
859<DD>Convert a DocList to a SolrDocumentList
860
861 The optional param "ids" is populated with the lucene document id
862 for each SolrDocument.
863<P>
864<DD><DL>
865<DT><B>Parameters:</B><DD><CODE>docs</CODE> - The <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search"><CODE>DocList</CODE></A> to convert<DD><CODE>searcher</CODE> - The <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search"><CODE>SolrIndexSearcher</CODE></A> to use to load the docs from the Lucene index<DD><CODE>fields</CODE> - The names of the Fields to load<DD><CODE>ids</CODE> - A map to store the ids of the docs
866<DT><B>Returns:</B><DD>The new <A HREF="../../../../org/apache/solr/common/SolrDocumentList.html" title="class in org.apache.solr.common"><CODE>SolrDocumentList</CODE></A> containing all the loaded docs
867<DT><B>Throws:</B>
868<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there was a problem loading the docs<DT><B>Since:</B></DT>
869  <DD>solr 1.4</DD>
870</DL>
871</DD>
872</DL>
873<HR>
874
875<A NAME="invokeSetters(java.lang.Object, org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
876invokeSetters</H3>
877<PRE>
878public static void <B>invokeSetters</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;bean,
879                                 <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;initArgs)</PRE>
880<DL>
881<DD><DL>
882</DL>
883</DD>
884</DL>
885<!-- ========= END OF CLASS DATA ========= -->
886<HR>
887
888
889<!-- ======= START OF BOTTOM NAVBAR ====== -->
890<A NAME="navbar_bottom"><!-- --></A>
891<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
892<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
893<TR>
894<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
895<A NAME="navbar_bottom_firstrow"><!-- --></A>
896<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
897  <TR ALIGN="center" VALIGN="top">
898  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
899  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
900  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
901  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SolrPluginUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
902  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
903  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
904  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
905  </TR>
906</TABLE>
907</TD>
908<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
909</EM>
910</TD>
911</TR>
912
913<TR>
914<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
915&nbsp;<A HREF="../../../../org/apache/solr/util/SimplePostTool.html" title="class in org.apache.solr.util"><B>PREV CLASS</B></A>&nbsp;
916&nbsp;<A HREF="../../../../org/apache/solr/util/SolrPluginUtils.DisjunctionMaxQueryParser.html" title="class in org.apache.solr.util"><B>NEXT CLASS</B></A></FONT></TD>
917<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
918  <A HREF="../../../../index.html?org/apache/solr/util/SolrPluginUtils.html" target="_top"><B>FRAMES</B></A>  &nbsp;
919&nbsp;<A HREF="SolrPluginUtils.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
920&nbsp;<SCRIPT type="text/javascript">
921  <!--
922  if(window==top) {
923    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
924  }
925  //-->
926</SCRIPT>
927<NOSCRIPT>
928  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
929</NOSCRIPT>
930
931
932</FONT></TD>
933</TR>
934<TR>
935<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
936  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
937<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
938DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
939</TR>
940</TABLE>
941<A NAME="skip-navbar_bottom"></A>
942<!-- ======== END OF BOTTOM NAVBAR ======= -->
943
944<HR>
945
946          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
947          <script src='../../../../prettify.js' type='text/javascript'></script>
948          <script type='text/javascript'>
949            (function(){
950              var oldonload = window.onload;
951              if (typeof oldonload != 'function') {
952                window.onload = prettyPrint;
953              } else {
954                window.onload = function() {
955                  oldonload();
956                  prettyPrint();
957                }
958              }
959            })();
960          </script>
961       
962</BODY>
963</HTML>
Note: See TracBrowser for help on using the repository browser.