Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

AnalysisRequestHandlerBase.html @ 7588

Revision 7588, 28.8 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>
8	AnalysisRequestHandlerBase (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">
16	function windowTitle()
17	{
18	if (location.href.indexOf('is-external=true') == -1) {
19	parent.document.title="AnalysisRequestHandlerBase (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> </TD>
42	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
44	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AnalysisRequestHandlerBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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	PREV CLASS
59	<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.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/AnalysisRequestHandlerBase.html" target="_top"><B>FRAMES</B></A>
62	<A HREF="AnalysisRequestHandlerBase.html" target="_top"><B>NO FRAMES</B></A>
63	<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: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
80	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <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">
91	org.apache.solr.handler</FONT>
92	<BR>
93	Class AnalysisRequestHandlerBase</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 "><B>org.apache.solr.handler.AnalysisRequestHandlerBase</B>
98	</PRE>
99	<DL>
100	<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>
101	</DL>
102	<DL>
103	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/handler/DocumentAnalysisRequestHandler.html" title="class in org.apache.solr.handler">DocumentAnalysisRequestHandler</A>, <A HREF="../../../../org/apache/solr/handler/FieldAnalysisRequestHandler.html" title="class in org.apache.solr.handler">FieldAnalysisRequestHandler</A></DD>
104	</DL>
105	<HR>
106	<DL>
107	<DT><PRE>public abstract class <B>AnalysisRequestHandlerBase</B><DT>extends <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></DL>
108	</PRE>
109
110	<P>
111	A base class for all analysis request handlers.
112	<P>
113
114	<P>
115	<DL>
116	<DT><B>Since:</B></DT>
117	<DD>solr 1.4</DD>
118	</DL>
119	<HR>
120
121	<P>
122	<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124	<A NAME="nested_class_summary"><!-- --></A>
125	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
128	<B>Nested Class Summary</B></FONT></TH>
129	</TR>
130	<TR BGCOLOR="white" CLASS="TableRowColor">
131	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132	<CODE>protected static class</CODE></FONT></TD>
133	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.AnalysisContext</A></B></CODE>
134
135	<BR>
136	Serves as the context of an analysis process.</TD>
137	</TR>
138	<TR BGCOLOR="white" CLASS="TableRowColor">
139	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140	<CODE>protected static class</CODE></FONT></TD>
141	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.ListBasedTokenStream.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.ListBasedTokenStream</A></B></CODE>
142
143	<BR>
144	TokenStream that iterates over a list of pre-existing Tokens</TD>
145	</TR>
146	<TR BGCOLOR="white" CLASS="TableRowColor">
147	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148	<CODE>static interface</CODE></FONT></TD>
149	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.TokenTrackingAttribute.html" title="interface in org.apache.solr.handler">AnalysisRequestHandlerBase.TokenTrackingAttribute</A></B></CODE>
150
151	<BR>
152	This is an <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/Attribute.html?is-external=true" title="class or interface in org.apache.lucene.util"><CODE>Attribute</CODE></A> used to track the positions of tokens
153	in the analysis chain.</TD>
154	</TR>
155	<TR BGCOLOR="white" CLASS="TableRowColor">
156	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157	<CODE>static class</CODE></FONT></TD>
158	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.TokenTrackingAttributeImpl.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.TokenTrackingAttributeImpl</A></B></CODE>
159
160	<BR>
161	Implementation of <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.TokenTrackingAttribute.html" title="interface in org.apache.solr.handler"><CODE>AnalysisRequestHandlerBase.TokenTrackingAttribute</CODE></A>.</TD>
162	</TR>
163	</TABLE>
164	<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
165	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
167	<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>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
171	</TR>
172	</TABLE>
173
174	<!-- =========== FIELD SUMMARY =========== -->
175
176	<A NAME="field_summary"><!-- --></A>
177	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
180	<B>Field Summary</B></FONT></TH>
181	</TR>
182	<TR BGCOLOR="white" CLASS="TableRowColor">
183	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184	<CODE>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><<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>></CODE></FONT></TD>
185	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#EMPTY_BYTES_SET">EMPTY_BYTES_SET</A></B></CODE>
186
187	<BR>
188	</TD>
189	</TR>
190	</TABLE>
191	<A NAME="fields_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
192	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
194	<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>
195	</TR>
196	<TR BGCOLOR="white" CLASS="TableRowColor">
197	<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>
198	</TR>
199	</TABLE>
200
201	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
202
203	<A NAME="constructor_summary"><!-- --></A>
204	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
207	<B>Constructor Summary</B></FONT></TH>
208	</TR>
209	<TR BGCOLOR="white" CLASS="TableRowColor">
210	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#AnalysisRequestHandlerBase()">AnalysisRequestHandlerBase</A></B>()</CODE>
211
212	<BR>
213	</TD>
214	</TR>
215	</TABLE>
216
217	<!-- ========== METHOD SUMMARY =========== -->
218
219	<A NAME="method_summary"><!-- --></A>
220	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
223	<B>Method Summary</B></FONT></TH>
224	</TR>
225	<TR BGCOLOR="white" CLASS="TableRowColor">
226	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227	<CODE>protected  <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A><? 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>></CODE></FONT></TD>
228	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#analyzeValue(java.lang.String, org.apache.solr.handler.AnalysisRequestHandlerBase.AnalysisContext)">analyzeValue</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> value,
229	<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.AnalysisContext</A> context)</CODE>
230
231	<BR>
232	Analyzes the given value using the given Analyzer.</TD>
233	</TR>
234	<TR BGCOLOR="white" CLASS="TableRowColor">
235	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236	<CODE>protected abstract  <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
237	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.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> req)</CODE>
238
239	<BR>
240	Performs the analysis based on the given solr request and returns the analysis result as a named list.</TD>
241	</TR>
242	<TR BGCOLOR="white" CLASS="TableRowColor">
243	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244	<CODE>protected  <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><<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>></CODE></FONT></TD>
245	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#getQueryTokenSet(java.lang.String, org.apache.lucene.analysis.Analyzer)">getQueryTokenSet</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> query,
246	<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> analyzer)</CODE>
247
248	<BR>
249	Analyzes the given text using the given analyzer and returns the produced tokens.</TD>
250	</TR>
251	<TR BGCOLOR="white" CLASS="TableRowColor">
252	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253	<CODE> void</CODE></FONT></TD>
254	<TD><CODE><B><A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequestBody</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> req,
255	<A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A> rsp)</CODE>
256
257	<BR>
258	</TD>
259	</TR>
260	</TABLE>
261	<A NAME="methods_inherited_from_class_org.apache.solr.handler.RequestHandlerBase"><!-- --></A>
262	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
264	<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>
265	</TR>
266	<TR BGCOLOR="white" CLASS="TableRowColor">
267	<TD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getCategory()">getCategory</A>, <A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#getDescription()">getDescription</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#getSource()">getSource</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>
268	</TR>
269	</TABLE>
270	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
271	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
272	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
273	<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>
274	</TR>
275	<TR BGCOLOR="white" CLASS="TableRowColor">
276	<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>
277	</TR>
278	</TABLE>
279
280	<P>
281
282	<!-- ============ FIELD DETAIL =========== -->
283
284	<A NAME="field_detail"><!-- --></A>
285	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
286	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
287	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
288	<B>Field Detail</B></FONT></TH>
289	</TR>
290	</TABLE>
291
292	<A NAME="EMPTY_BYTES_SET"><!-- --></A><H3>
293	EMPTY_BYTES_SET</H3>
294	<PRE>
295	public static final <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><<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>> <B>EMPTY_BYTES_SET</B></PRE>
296	<DL>
297	<DL>
298	</DL>
299	</DL>
300
301	<!-- ========= CONSTRUCTOR DETAIL ======== -->
302
303	<A NAME="constructor_detail"><!-- --></A>
304	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
305	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
306	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
307	<B>Constructor Detail</B></FONT></TH>
308	</TR>
309	</TABLE>
310
311	<A NAME="AnalysisRequestHandlerBase()"><!-- --></A><H3>
312	AnalysisRequestHandlerBase</H3>
313	<PRE>
314	public <B>AnalysisRequestHandlerBase</B>()</PRE>
315	<DL>
316	</DL>
317
318	<!-- ============ METHOD DETAIL ========== -->
319
320	<A NAME="method_detail"><!-- --></A>
321	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
322	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
323	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
324	<B>Method Detail</B></FONT></TH>
325	</TR>
326	</TABLE>
327
328	<A NAME="handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
329	handleRequestBody</H3>
330	<PRE>
331	public void <B>handleRequestBody</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> req,
332	<A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A> rsp)
333	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>
334	<DL>
335	<DD><DL>
336	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html#handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">handleRequestBody</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/handler/RequestHandlerBase.html" title="class in org.apache.solr.handler">RequestHandlerBase</A></CODE></DL>
337	</DD>
338	<DD><DL>
339
340	<DT><B>Throws:</B>
341	<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></DL>
342	</DD>
343	</DL>
344	<HR>
345
346	<A NAME="doAnalysis(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
347	doAnalysis</H3>
348	<PRE>
349	protected abstract <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> req)
350	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>
351	<DL>
352	<DD>Performs the analysis based on the given solr request and returns the analysis result as a named list.
353	<P>
354	<DD><DL>
355	<DT><B>Parameters:</B><DD><CODE>req</CODE> - The solr request.
356	<DT><B>Returns:</B><DD>The analysis result as a named list.
357	<DT><B>Throws:</B>
358	<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>
359	</DD>
360	</DL>
361	<HR>
362
363	<A NAME="analyzeValue(java.lang.String, org.apache.solr.handler.AnalysisRequestHandlerBase.AnalysisContext)"><!-- --></A><H3>
364	analyzeValue</H3>
365	<PRE>
366	protected <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A><? 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>> <B>analyzeValue</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> value,
367	<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.html" title="class in org.apache.solr.handler">AnalysisRequestHandlerBase.AnalysisContext</A> context)</PRE>
368	<DL>
369	<DD>Analyzes the given value using the given Analyzer.
370	<P>
371	<DD><DL>
372	<DT><B>Parameters:</B><DD><CODE>value</CODE> - Value to analyze<DD><CODE>context</CODE> - The <A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.html" title="class in org.apache.solr.handler"><CODE>analysis context</CODE></A>.
373	<DT><B>Returns:</B><DD>NamedList containing the tokens produced by analyzing the given value</DL>
374	</DD>
375	</DL>
376	<HR>
377
378	<A NAME="getQueryTokenSet(java.lang.String, org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
379	getQueryTokenSet</H3>
380	<PRE>
381	protected <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><<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>> <B>getQueryTokenSet</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> query,
382	<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> analyzer)</PRE>
383	<DL>
384	<DD>Analyzes the given text using the given analyzer and returns the produced tokens.
385	<P>
386	<DD><DL>
387	<DT><B>Parameters:</B><DD><CODE>query</CODE> - The query to analyze.<DD><CODE>analyzer</CODE> - The analyzer to use.</DL>
388	</DD>
389	</DL>
390	<!-- ========= END OF CLASS DATA ========= -->
391	<HR>
392
393
394	<!-- ======= START OF BOTTOM NAVBAR ====== -->
395	<A NAME="navbar_bottom"><!-- --></A>
396	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
397	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
398	<TR>
399	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
400	<A NAME="navbar_bottom_firstrow"><!-- --></A>
401	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
402	<TR ALIGN="center" VALIGN="top">
403	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
404	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
405	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
406	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AnalysisRequestHandlerBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
407	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
408	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
409	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
410	</TR>
411	</TABLE>
412	</TD>
413	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
414	</EM>
415	</TD>
416	</TR>
417
418	<TR>
419	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
420	PREV CLASS
421	<A HREF="../../../../org/apache/solr/handler/AnalysisRequestHandlerBase.AnalysisContext.html" title="class in org.apache.solr.handler"><B>NEXT CLASS</B></A></FONT></TD>
422	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
423	<A HREF="../../../../index.html?org/apache/solr/handler/AnalysisRequestHandlerBase.html" target="_top"><B>FRAMES</B></A>
424	<A HREF="AnalysisRequestHandlerBase.html" target="_top"><B>NO FRAMES</B></A>
425	<SCRIPT type="text/javascript">
426	<!--
427	if(window==top) {
428	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
429	}
430	//-->
431	</SCRIPT>
432	<NOSCRIPT>
433	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
434	</NOSCRIPT>
435
436
437	</FONT></TD>
438	</TR>
439	<TR>
440	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
441	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
442	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
443	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
444	</TR>
445	</TABLE>
446	<A NAME="skip-navbar_bottom"></A>
447	<!-- ======== END OF BOTTOM NAVBAR ======= -->
448
449	<HR>
450
451	<address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address>
452	<script src='../../../../prettify.js' type='text/javascript'></script>
453	<script type='text/javascript'>
454	(function(){
455	var oldonload = window.onload;
456	if (typeof oldonload != 'function') {
457	window.onload = prettyPrint;
458	} else {
459	window.onload = function() {
460	oldonload();
461	prettyPrint();
462	}
463	}
464	})();
465	</script>
466
467	</BODY>
468	</HTML>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

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

Download in other formats: