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

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

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8DocumentAnalysisRequestHandler (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="DocumentAnalysisRequestHandler (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/DocumentAnalysisRequestHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../org/apache/solr/handler/CSVRequestHandler.html" title="class in org.apache.solr.handler"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/handler/DumpRequestHandler.html" title="class in org.apache.solr.handler"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/handler/DocumentAnalysisRequestHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DocumentAnalysisRequestHandler.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_classes_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.handler</FONT>
92<BR>
93Class DocumentAnalysisRequestHandler</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 "><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">org.apache.solr.handler.RequestHandlerBase</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html" title="class in org.apache.solr.handler">org.apache.solr.handler.AnalysisRequestHandlerBase</A>
98          <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.DocumentAnalysisRequestHandler</B>
99</PRE>
100<DL>
101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A>, <A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request">SolrRequestHandler</A></DD>
102</DL>
103<HR>
104<DL>
105<DT><PRE>public class <B>DocumentAnalysisRequestHandler</B><DT>extends <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase</A></DL>
106</PRE>
107
108<P>
109An analysis handler that provides a breakdown of the analysis process of provided docuemnts. This handler expects a
110 (single) content stream of the following format:
111 <p/>
112 <pre><code>
113  &lt;docs&gt;
114      &lt;doc&gt;
115          &lt;field name="id"&gt;1&lt;/field&gt;
116          &lt;field name="name"&gt;The Name&lt;/field&gt;
117          &lt;field name="text"&gt;The Text Value&lt;/field&gt;
118      &lt;doc&gt;
119      &lt;doc&gt;...&lt;/doc&gt;
120      &lt;doc&gt;...&lt;/doc&gt;
121      ...
122  &lt;/docs&gt;
123 </code></pre>
124 <p/>
125 <em><b>Note: Each document must contain a field which serves as the unique key. This key is used in the returned
126 response to assoicate an analysis breakdown to the analyzed document.</b></em>
127 <p/>
128 <p/>
129 <p/>
130 Like the <A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.html" title="class in org.apache.solr.handler"><CODE>FieldAnalysisRequestHandler</CODE></A>, this handler also supports query analysis by
131 sending either an "analysis.query" or "q" request paraemter that holds the query text to be analyzed. It also
132 supports the "analysis.showmatch" parameter which when set to <code>true</code>, all field tokens that match the query
133 tokens will be marked as a "match".
134<P>
135
136<P>
137<DL>
138<DT><B>Since:</B></DT>
139  <DD>solr 1.4</DD>
140</DL>
141<HR>
142
143<P>
144<!-- ======== NESTED CLASS SUMMARY ======== -->
145
146<A NAME="nested_class_summary"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
149<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
150<B>Nested Class Summary</B></FONT></TH>
151</TR>
152</TABLE>
153&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
156<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase</A></B></TH>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD><CODE><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.AnalysisContext</A>, <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.ListBasedTokenStream.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.ListBasedTokenStream</A>, <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.TokenTrackingAttribute.html" title="interface in org.apache.solr.handler">AnalysisRequestHandlerBase.TokenTrackingAttribute</A>, <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.TokenTrackingAttributeImpl.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.TokenTrackingAttributeImpl</A></CODE></TD>
160</TR>
161</TABLE>
162&nbsp;
163<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
166<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.core.<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
170</TR>
171</TABLE>
172&nbsp;
173<!-- =========== FIELD SUMMARY =========== -->
174
175<A NAME="field_summary"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
178<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
179<B>Field Summary</B></FONT></TH>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html#log">log</A></B></CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
188</TR>
189</TABLE>
190&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
193<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase</A></B></TH>
194</TR>
195<TR BGCOLOR="white" CLASS="TableRowColor">
196<TD><CODE><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#EMPTY_BYTES_SET">EMPTY_BYTES_SET</A></CODE></TD>
197</TR>
198</TABLE>
199&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
202<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></B></TH>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#appends">appends</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#defaults">defaults</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#httpCaching">httpCaching</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#initArgs">initArgs</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#invariants">invariants</A></CODE></TD>
206</TR>
207</TABLE>
208&nbsp;
209<!-- ======== CONSTRUCTOR SUMMARY ======== -->
210
211<A NAME="constructor_summary"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
215<B>Constructor Summary</B></FONT></TH>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html#DocumentAnalysisRequestHandler()">DocumentAnalysisRequestHandler</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
222</TR>
223</TABLE>
224&nbsp;
225<!-- ========== METHOD SUMMARY =========== -->
226
227<A NAME="method_summary"><!-- --></A>
228<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
229<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
230<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
231<B>Method Summary</B></FONT></TH>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>protected &nbsp;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html#doAnalysis(org.apache.solr.request.SolrQueryRequest)">doAnalysis</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req)</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs the analysis based on the given solr request and returns the analysis result as a named list.</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&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>
244<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html#getDescription()">getDescription</A></B>()</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&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>
252<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html#getSource()">getSource</A></B>()</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<CODE>&nbsp;void</CODE></FONT></TD>
260<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the <A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request"><CODE>SolrRequestHandler</CODE></A> by creating three <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><CODE>SolrParams</CODE></A> named.</TD>
264</TR>
265</TABLE>
266&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase"><!-- --></A>
267<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
268<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
269<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase</A></B></TH>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD><CODE><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#analyzeValue(java.lang.String, org.apache.solr.handler.AnalysisRequestHandlerBase.AnalysisContext)">analyzeValue</A>, <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#getQueryTokenSet(java.lang.String, org.apache.lucene.analysis.Analyzer)">getQueryTokenSet</A>, <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequestBody</A></CODE></TD>
273</TR>
274</TABLE>
275&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
276<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
278<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.<A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></B></TH>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getCategory()">getCategory</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getDocs()">getDocs</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getInitArgs()">getInitArgs</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getName()">getName</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getStatistics()">getStatistics</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getVersion()">getVersion</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequest</A></CODE></TD>
282</TR>
283</TABLE>
284&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
285<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
286<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
287<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>
288</TR>
289<TR BGCOLOR="white" CLASS="TableRowColor">
290<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>
291</TR>
292</TABLE>
293&nbsp;
294<P>
295
296<!-- ============ FIELD DETAIL =========== -->
297
298<A NAME="field_detail"><!-- --></A>
299<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
300<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
301<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
302<B>Field Detail</B></FONT></TH>
303</TR>
304</TABLE>
305
306<A NAME="log"><!-- --></A><H3>
307log</H3>
308<PRE>
309public static final org.slf4j.Logger <B>log</B></PRE>
310<DL>
311<DL>
312</DL>
313</DL>
314
315<!-- ========= CONSTRUCTOR DETAIL ======== -->
316
317<A NAME="constructor_detail"><!-- --></A>
318<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
319<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
320<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
321<B>Constructor Detail</B></FONT></TH>
322</TR>
323</TABLE>
324
325<A NAME="DocumentAnalysisRequestHandler()"><!-- --></A><H3>
326DocumentAnalysisRequestHandler</H3>
327<PRE>
328public <B>DocumentAnalysisRequestHandler</B>()</PRE>
329<DL>
330</DL>
331
332<!-- ============ METHOD DETAIL ========== -->
333
334<A NAME="method_detail"><!-- --></A>
335<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
336<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
337<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
338<B>Method Detail</B></FONT></TH>
339</TR>
340</TABLE>
341
342<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
343init</H3>
344<PRE>
345public void <B>init</B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
346<DL>
347<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#init(org.apache.solr.common.util.NamedList)">RequestHandlerBase</A></CODE></B></DD>
348<DD>Initializes the <A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request"><CODE>SolrRequestHandler</CODE></A> by creating three <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><CODE>SolrParams</CODE></A> named.
349 <table border="1">
350 <tr><th>Name</th><th>Description</th></tr>
351 <tr><td>defaults</td><td>Contains all of the named arguments contained within the list element named "defaults".</td></tr>
352 <tr><td>appends</td><td>Contains all of the named arguments contained within the list element named "appends".</td></tr>
353 <tr><td>invariants</td><td>Contains all of the named arguments contained within the list element named "invariants".</td></tr>
354 </table>
355
356 Example:
357 <pre>
358 &lt;lst name="defaults"&gt;
359 &lt;str name="echoParams"&gt;explicit&lt;/str&gt;
360 &lt;str name="qf"&gt;text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0&lt;/str&gt;
361 &lt;str name="mm"&gt;2&lt;-1 5&lt;-2 6&lt;90%&lt;/str&gt;
362 &lt;str name="bq"&gt;incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2&lt;/str&gt;
363 &lt;/lst&gt;
364 &lt;lst name="appends"&gt;
365 &lt;str name="fq"&gt;inStock:true&lt;/str&gt;
366 &lt;/lst&gt;
367
368 &lt;lst name="invariants"&gt;
369 &lt;str name="facet.field"&gt;cat&lt;/str&gt;
370 &lt;str name="facet.field"&gt;manu_exact&lt;/str&gt;
371 &lt;str name="facet.query"&gt;price:[* TO 500]&lt;/str&gt;
372 &lt;str name="facet.query"&gt;price:[500 TO *]&lt;/str&gt;
373 &lt;/lst&gt;
374 </pre>
375<P>
376<DD><DL>
377<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/request/SolrRequestHandler.html" title="interface in org.apache.solr.request">SolrRequestHandler</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
378</DD>
379<DD><DL>
380<DT><B>Parameters:</B><DD><CODE>args</CODE> - The <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util"><CODE>NamedList</CODE></A> to initialize from<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><CODE>RequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)</CODE></A>,
381<A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><CODE>RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)</CODE></A>,
382<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)"><CODE>SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)</CODE></A>,
383<A HREF="../../../../org/apache/solr/common/params/SolrParams.html#toSolrParams(org.apache.solr.common.util.NamedList)"><CODE>See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).</CODE></A></DL>
384</DD>
385</DL>
386<HR>
387
388<A NAME="doAnalysis(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
389doAnalysis</H3>
390<PRE>
391protected <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>doAnalysis</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req)
392                        throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
393<DL>
394<DD>Performs the analysis based on the given solr request and returns the analysis result as a named list.
395<P>
396<DD><DL>
397<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#doAnalysis(org.apache.solr.request.SolrQueryRequest)">doAnalysis</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase</A></CODE></DL>
398</DD>
399<DD><DL>
400<DT><B>Parameters:</B><DD><CODE>req</CODE> - The solr request.
401<DT><B>Returns:</B><DD>The analysis result as a named list.
402<DT><B>Throws:</B>
403<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - When analysis fails.</DL>
404</DD>
405</DL>
406<HR>
407
408<A NAME="getDescription()"><!-- --></A><H3>
409getDescription</H3>
410<PRE>
411public <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>getDescription</B>()</PRE>
412<DL>
413<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
414<DD>Simple one or two line description
415<P>
416<DD><DL>
417<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
418</DD>
419<DD><DL>
420</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="getSource()"><!-- --></A><H3>
426getSource</H3>
427<PRE>
428public <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>getSource</B>()</PRE>
429<DL>
430<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
431<DD>CVS Source, SVN Source, etc
432<P>
433<DD><DL>
434<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
435</DD>
436<DD><DL>
437</DL>
438</DD>
439</DL>
440<!-- ========= END OF CLASS DATA ========= -->
441<HR>
442
443
444<!-- ======= START OF BOTTOM NAVBAR ====== -->
445<A NAME="navbar_bottom"><!-- --></A>
446<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
447<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
448<TR>
449<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
450<A NAME="navbar_bottom_firstrow"><!-- --></A>
451<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
452  <TR ALIGN="center" VALIGN="top">
453  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
454  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
455  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
456  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DocumentAnalysisRequestHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
457  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
458  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
459  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
460  </TR>
461</TABLE>
462</TD>
463<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
464</EM>
465</TD>
466</TR>
467
468<TR>
469<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
470&nbsp;<A HREF="../../../../org/apache/solr/handler/CSVRequestHandler.html" title="class in org.apache.solr.handler"><B>PREV CLASS</B></A>&nbsp;
471&nbsp;<A HREF="../../../../org/apache/solr/handler/DumpRequestHandler.html" title="class in org.apache.solr.handler"><B>NEXT CLASS</B></A></FONT></TD>
472<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
473  <A HREF="../../../../index.html?org/apache/solr/handler/DocumentAnalysisRequestHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
474&nbsp;<A HREF="DocumentAnalysisRequestHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
475&nbsp;<SCRIPT type="text/javascript">
476  <!--
477  if(window==top) {
478    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
479  }
480  //-->
481</SCRIPT>
482<NOSCRIPT>
483  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
484</NOSCRIPT>
485
486
487</FONT></TD>
488</TR>
489<TR>
490<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
491  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
492<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
493DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
494</TR>
495</TABLE>
496<A NAME="skip-navbar_bottom"></A>
497<!-- ======== END OF BOTTOM NAVBAR ======= -->
498
499<HR>
500
501          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
502          <script src='../../../../prettify.js' type='text/javascript'></script>
503          <script type='text/javascript'>
504            (function(){
505              var oldonload = window.onload;
506              if (typeof oldonload != 'function') {
507                window.onload = prettyPrint;
508              } else {
509                window.onload = function() {
510                  oldonload();
511                  prettyPrint();
512                }
513              }
514            })();
515          </script>
516       
517</BODY>
518</HTML>
Note: See TracBrowser for help on using the repository browser.