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

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

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8FieldAnalysisRequestHandler (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="FieldAnalysisRequestHandler (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/FieldAnalysisRequestHandler.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/DumpRequestHandler.html" title="class in org.apache.solr.handler"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/handler/JsonUpdateRequestHandler.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/FieldAnalysisRequestHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FieldAnalysisRequestHandler.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="#fields_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase">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;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.handler</FONT>
92<BR>
93Class FieldAnalysisRequestHandler</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.FieldAnalysisRequestHandler</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>FieldAnalysisRequestHandler</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>
109Provides the ability to specify multiple field types and field names in the same request. Expected parameters:
110 <table border="1">
111 <tr>
112 <th align="left">Name</th>
113 <th align="left">Type</th>
114 <th align="left">required</th>
115 <th align="left">Description</th>
116 <th align="left">Multi-valued</th>
117 </tr>
118 <tr>
119 <td>analysis.fieldname</td>
120 <td>string</td>
121 <td>no</td>
122 <td>When present, the text will be analyzed based on the type of this field name.</td>
123 <td>Yes, this parameter may hold a comma-separated list of values and the analysis will be performed for each of the specified fields</td>
124 </tr>
125 <tr>
126 <td>analysis.fieldtype</td>
127 <td>string</td>
128 <td>no</td>
129 <td>When present, the text will be analyzed based on the specified type</td>
130 <td>Yes, this parameter may hold a comma-separated list of values and the analysis will be performed for each of the specified field types</td>
131 </tr>
132 <tr>
133 <td>analysis.fieldvalue</td>
134 <td>string</td>
135 <td>yes</td>
136 <td>The text that will be analyzed. The analysis will mimic the index-time analysis.</td>
137 <td>No</td>
138 </tr>
139 <tr>
140 <td><code>analysis.query</code> OR <code>q</code></td>
141 <td>string</td>
142 <td>no</td>
143 <td>When present, the text that will be analyzed. The analysis will mimic the query-time analysis. Note that the
144 <code>analysis.query</code> parameter as precedes the <code>q</code> parameters.</td>
145 <td>No</td>
146 </tr>
147 <tr>
148 <td>analysis.showmatch</td>
149 <td>boolean</td>
150 <td>no</td>
151 <td>When set to <code>true</code> and when query analysis is performed, the produced tokens of the field value
152 analysis will be marked as "matched" for every token that is produces by the query analysis</td>
153 <td>No</td>
154 </tr>
155 </table>
156 <p>Note that if neither analysis.fieldname and analysis.fieldtype is specified, then the default search field's
157 analyzer is used.</p>
158<P>
159
160<P>
161<DL>
162<DT><B>Since:</B></DT>
163  <DD>solr 1.4</DD>
164</DL>
165<HR>
166
167<P>
168<!-- ======== NESTED CLASS SUMMARY ======== -->
169
170<A NAME="nested_class_summary"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
173<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
174<B>Nested Class Summary</B></FONT></TH>
175</TR>
176</TABLE>
177&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
180<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>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<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>
184</TR>
185</TABLE>
186&nbsp;
187<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
188<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
189<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
190<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>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
194</TR>
195</TABLE>
196&nbsp;
197<!-- =========== FIELD SUMMARY =========== -->
198
199<A NAME="field_summary"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
203<B>Field Summary</B></FONT></TH>
204</TR>
205</TABLE>
206&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase"><!-- --></A>
207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
208<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
209<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>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD><CODE><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#EMPTY_BYTES_SET">EMPTY_BYTES_SET</A></CODE></TD>
213</TR>
214</TABLE>
215&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
218<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>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<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>
222</TR>
223</TABLE>
224&nbsp;
225<!-- ======== CONSTRUCTOR SUMMARY ======== -->
226
227<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.html#FieldAnalysisRequestHandler()">FieldAnalysisRequestHandler</A></B>()</CODE>
235
236<BR>
237&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
238</TR>
239</TABLE>
240&nbsp;
241<!-- ========== METHOD SUMMARY =========== -->
242
243<A NAME="method_summary"><!-- --></A>
244<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
245<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
246<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
247<B>Method Summary</B></FONT></TH>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<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>
252<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.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>
253
254<BR>
255&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>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<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>
260<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.html#getDescription()">getDescription</A></B>()</CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<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>
268<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.html#getSource()">getSource</A></B>()</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
272</TR>
273<TR BGCOLOR="white" CLASS="TableRowColor">
274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275<CODE>protected &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>&gt;</CODE></FONT></TD>
276<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.html#handleAnalysisRequest(org.apache.solr.client.solrj.request.FieldAnalysisRequest, org.apache.solr.schema.IndexSchema)">handleAnalysisRequest</A></B>(<A HREF="../../../../org/apache/solr/client/solrj/request/FieldAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">FieldAnalysisRequest</A>&nbsp;request,
277                      <A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema)</CODE>
278
279<BR>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles the resolved analysis request and returns the analysis breakdown response as a named list.</TD>
281</TR>
282</TABLE>
283&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase"><!-- --></A>
284<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
285<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
286<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>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<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>
290</TR>
291</TABLE>
292&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
293<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
294<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
295<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>
296</TR>
297<TR BGCOLOR="white" CLASS="TableRowColor">
298<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>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE></TD>
299</TR>
300</TABLE>
301&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
302<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
303<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
304<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>
305</TR>
306<TR BGCOLOR="white" CLASS="TableRowColor">
307<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>
308</TR>
309</TABLE>
310&nbsp;
311<P>
312
313<!-- ========= CONSTRUCTOR DETAIL ======== -->
314
315<A NAME="constructor_detail"><!-- --></A>
316<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
317<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
318<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
319<B>Constructor Detail</B></FONT></TH>
320</TR>
321</TABLE>
322
323<A NAME="FieldAnalysisRequestHandler()"><!-- --></A><H3>
324FieldAnalysisRequestHandler</H3>
325<PRE>
326public <B>FieldAnalysisRequestHandler</B>()</PRE>
327<DL>
328</DL>
329
330<!-- ============ METHOD DETAIL ========== -->
331
332<A NAME="method_detail"><!-- --></A>
333<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
334<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
335<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
336<B>Method Detail</B></FONT></TH>
337</TR>
338</TABLE>
339
340<A NAME="doAnalysis(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
341doAnalysis</H3>
342<PRE>
343protected <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)
344                        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>
345<DL>
346<DD>Performs the analysis based on the given solr request and returns the analysis result as a named list.
347<P>
348<DD><DL>
349<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>
350</DD>
351<DD><DL>
352<DT><B>Parameters:</B><DD><CODE>req</CODE> - The solr request.
353<DT><B>Returns:</B><DD>The analysis result as a named list.
354<DT><B>Throws:</B>
355<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>
356</DD>
357</DL>
358<HR>
359
360<A NAME="getDescription()"><!-- --></A><H3>
361getDescription</H3>
362<PRE>
363public <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>
364<DL>
365<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
366<DD>Simple one or two line description
367<P>
368<DD><DL>
369<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>
370</DD>
371<DD><DL>
372</DL>
373</DD>
374</DL>
375<HR>
376
377<A NAME="getSource()"><!-- --></A><H3>
378getSource</H3>
379<PRE>
380public <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>
381<DL>
382<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
383<DD>CVS Source, SVN Source, etc
384<P>
385<DD><DL>
386<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>
387</DD>
388<DD><DL>
389</DL>
390</DD>
391</DL>
392<HR>
393
394<A NAME="handleAnalysisRequest(org.apache.solr.client.solrj.request.FieldAnalysisRequest, org.apache.solr.schema.IndexSchema)"><!-- --></A><H3>
395handleAnalysisRequest</H3>
396<PRE>
397protected <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>&gt; <B>handleAnalysisRequest</B>(<A HREF="../../../../org/apache/solr/client/solrj/request/FieldAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">FieldAnalysisRequest</A>&nbsp;request,
398                                                     <A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema)</PRE>
399<DL>
400<DD>Handles the resolved analysis request and returns the analysis breakdown response as a named list.
401<P>
402<DD><DL>
403<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request to handle.<DD><CODE>schema</CODE> - The index schema.
404<DT><B>Returns:</B><DD>The analysis breakdown as a named list.</DL>
405</DD>
406</DL>
407<!-- ========= END OF CLASS DATA ========= -->
408<HR>
409
410
411<!-- ======= START OF BOTTOM NAVBAR ====== -->
412<A NAME="navbar_bottom"><!-- --></A>
413<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
414<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
415<TR>
416<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
417<A NAME="navbar_bottom_firstrow"><!-- --></A>
418<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
419  <TR ALIGN="center" VALIGN="top">
420  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
421  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
422  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
423  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldAnalysisRequestHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
424  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
425  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
426  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
427  </TR>
428</TABLE>
429</TD>
430<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
431</EM>
432</TD>
433</TR>
434
435<TR>
436<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
437&nbsp;<A HREF="../../../../org/apache/solr/handler/DumpRequestHandler.html" title="class in org.apache.solr.handler"><B>PREV CLASS</B></A>&nbsp;
438&nbsp;<A HREF="../../../../org/apache/solr/handler/JsonUpdateRequestHandler.html" title="class in org.apache.solr.handler"><B>NEXT CLASS</B></A></FONT></TD>
439<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
440  <A HREF="../../../../index.html?org/apache/solr/handler/FieldAnalysisRequestHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
441&nbsp;<A HREF="FieldAnalysisRequestHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
442&nbsp;<SCRIPT type="text/javascript">
443  <!--
444  if(window==top) {
445    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
446  }
447  //-->
448</SCRIPT>
449<NOSCRIPT>
450  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
451</NOSCRIPT>
452
453
454</FONT></TD>
455</TR>
456<TR>
457<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
458  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.handler.AnalysisRequestHandlerBase">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
459<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
460DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
461</TR>
462</TABLE>
463<A NAME="skip-navbar_bottom"></A>
464<!-- ======== END OF BOTTOM NAVBAR ======= -->
465
466<HR>
467
468          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
469          <script src='../../../../prettify.js' type='text/javascript'></script>
470          <script type='text/javascript'>
471            (function(){
472              var oldonload = window.onload;
473              if (typeof oldonload != 'function') {
474                window.onload = prettyPrint;
475              } else {
476                window.onload = function() {
477                  oldonload();
478                  prettyPrint();
479                }
480              }
481            })();
482          </script>
483       
484</BODY>
485</HTML>
Note: See TracBrowser for help on using the repository browser.