source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html @ 7588

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

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8DocumentAnalysisRequest (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="DocumentAnalysisRequest (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/DocumentAnalysisRequest.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/client/solrj/request/DirectXmlRequest.html" title="class in org.apache.solr.client.solrj.request"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/request/FieldAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DocumentAnalysisRequest.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.client.solrj.SolrRequest">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.solr.client.solrj.request</FONT>
92<BR>
93Class DocumentAnalysisRequest</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/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">org.apache.solr.client.solrj.SolrRequest</A>
97      <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.client.solrj.request.DocumentAnalysisRequest</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>DocumentAnalysisRequest</B><DT>extends <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">SolrRequest</A></DL>
105</PRE>
106
107<P>
108A request for the org.apache.solr.handler.DocumentAnalysisRequestHandler.
109<P>
110
111<P>
112<DL>
113<DT><B>Since:</B></DT>
114  <DD>solr 1.4</DD>
115<DT><B>See Also:</B><DD><A HREF="../../../../../../serialized-form.html#org.apache.solr.client.solrj.request.DocumentAnalysisRequest">Serialized Form</A></DL>
116<HR>
117
118<P>
119<!-- ======== NESTED CLASS SUMMARY ======== -->
120
121<A NAME="nested_class_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Nested Class Summary</B></FONT></TH>
126</TR>
127</TABLE>
128&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.client.solrj.SolrRequest"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
131<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.solr.client.solrj.<A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">SolrRequest</A></B></TH>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.METHOD.html" title="enum in org.apache.solr.client.solrj">SolrRequest.METHOD</A></CODE></TD>
135</TR>
136</TABLE>
137&nbsp;
138
139<!-- ======== CONSTRUCTOR SUMMARY ======== -->
140
141<A NAME="constructor_summary"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
145<B>Constructor Summary</B></FONT></TH>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#DocumentAnalysisRequest()">DocumentAnalysisRequest</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new request with a default uri of "/documentanalysis".</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#DocumentAnalysisRequest(java.lang.String)">DocumentAnalysisRequest</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;uri)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new request with the given request handler uri.</TD>
158</TR>
159</TABLE>
160&nbsp;
161<!-- ========== METHOD SUMMARY =========== -->
162
163<A NAME="method_summary"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
167<B>Method Summary</B></FONT></TH>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A></CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#addDocument(org.apache.solr.common.SolrInputDocument)">addDocument</A></B>(<A HREF="../../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&nbsp;doc)</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a document to be analyzed.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A></CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#addDocuments(java.util.Collection)">addDocuments</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&gt;&nbsp;docs)</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a collection of documents to be analyzed.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../../org/apache/solr/common/util/ContentStream.html" title="interface in org.apache.solr.common.util">ContentStream</A>&gt;</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#getContentStreams()">getContentStreams</A></B>()</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&gt;</CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#getDocuments()">getDocuments</A></B>()</CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all documents that will be analyzed when processing the request.</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<CODE>&nbsp;<A HREF="../../../../../../org/apache/solr/common/params/ModifiableSolrParams.html" title="class in org.apache.solr.common.params">ModifiableSolrParams</A></CODE></FONT></TD>
204<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#getParams()">getParams</A></B>()</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<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>
212<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#getQuery()">getQuery</A></B>()</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the query that will be analyzed when processing the request.</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219<CODE>&nbsp;boolean</CODE></FONT></TD>
220<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#isShowMatch()">isShowMatch</A></B>()</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether index time tokens that match query time tokens will be marked as a "match".</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/DocumentAnalysisResponse.html" title="class in org.apache.solr.client.solrj.response">DocumentAnalysisResponse</A></CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#process(org.apache.solr.client.solrj.SolrServer)">process</A></B>(<A HREF="../../../../../../org/apache/solr/client/solrj/SolrServer.html" title="class in org.apache.solr.client.solrj">SolrServer</A>&nbsp;server)</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A></CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#setQuery(java.lang.String)">setQuery</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;query)</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the query to be analyzed.</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="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A></CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#setShowMatch(boolean)">setShowMatch</A></B>(boolean&nbsp;showMatch)</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets whether index time tokens that match query time tokens should be marked as a "match".</TD>
248</TR>
249</TABLE>
250&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.client.solrj.SolrRequest"><!-- --></A>
251<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
252<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
253<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.client.solrj.<A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">SolrRequest</A></B></TH>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD><CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#getMethod()">getMethod</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#getPath()">getPath</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#getResponseParser()">getResponseParser</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#getStreamingResponseCallback()">getStreamingResponseCallback</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#setMethod(org.apache.solr.client.solrj.SolrRequest.METHOD)">setMethod</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#setPath(java.lang.String)">setPath</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#setResponseParser(org.apache.solr.client.solrj.ResponseParser)">setResponseParser</A>, <A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#setStreamingResponseCallback(org.apache.solr.client.solrj.StreamingResponseCallback)">setStreamingResponseCallback</A></CODE></TD>
257</TR>
258</TABLE>
259&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
260<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
261<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
262<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>
263</TR>
264<TR BGCOLOR="white" CLASS="TableRowColor">
265<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>
266</TR>
267</TABLE>
268&nbsp;
269<P>
270
271<!-- ========= CONSTRUCTOR DETAIL ======== -->
272
273<A NAME="constructor_detail"><!-- --></A>
274<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
275<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
276<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
277<B>Constructor Detail</B></FONT></TH>
278</TR>
279</TABLE>
280
281<A NAME="DocumentAnalysisRequest()"><!-- --></A><H3>
282DocumentAnalysisRequest</H3>
283<PRE>
284public <B>DocumentAnalysisRequest</B>()</PRE>
285<DL>
286<DD>Constructs a new request with a default uri of "/documentanalysis".
287<P>
288</DL>
289<HR>
290
291<A NAME="DocumentAnalysisRequest(java.lang.String)"><!-- --></A><H3>
292DocumentAnalysisRequest</H3>
293<PRE>
294public <B>DocumentAnalysisRequest</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;uri)</PRE>
295<DL>
296<DD>Constructs a new request with the given request handler uri.
297<P>
298<DL>
299<DT><B>Parameters:</B><DD><CODE>uri</CODE> - The of the request handler.</DL>
300</DL>
301
302<!-- ============ METHOD DETAIL ========== -->
303
304<A NAME="method_detail"><!-- --></A>
305<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
306<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
307<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
308<B>Method Detail</B></FONT></TH>
309</TR>
310</TABLE>
311
312<A NAME="getContentStreams()"><!-- --></A><H3>
313getContentStreams</H3>
314<PRE>
315public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../../org/apache/solr/common/util/ContentStream.html" title="interface in org.apache.solr.common.util">ContentStream</A>&gt; <B>getContentStreams</B>()
316                                            throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
317<DL>
318<DD>
319<P>
320<DD><DL>
321<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#getContentStreams()">getContentStreams</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">SolrRequest</A></CODE></DL>
322</DD>
323<DD><DL>
324
325<DT><B>Throws:</B>
326<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
327</DD>
328</DL>
329<HR>
330
331<A NAME="getParams()"><!-- --></A><H3>
332getParams</H3>
333<PRE>
334public <A HREF="../../../../../../org/apache/solr/common/params/ModifiableSolrParams.html" title="class in org.apache.solr.common.params">ModifiableSolrParams</A> <B>getParams</B>()</PRE>
335<DL>
336<DD>
337<P>
338<DD><DL>
339<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#getParams()">getParams</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">SolrRequest</A></CODE></DL>
340</DD>
341<DD><DL>
342</DL>
343</DD>
344</DL>
345<HR>
346
347<A NAME="process(org.apache.solr.client.solrj.SolrServer)"><!-- --></A><H3>
348process</H3>
349<PRE>
350public <A HREF="../../../../../../org/apache/solr/client/solrj/response/DocumentAnalysisResponse.html" title="class in org.apache.solr.client.solrj.response">DocumentAnalysisResponse</A> <B>process</B>(<A HREF="../../../../../../org/apache/solr/client/solrj/SolrServer.html" title="class in org.apache.solr.client.solrj">SolrServer</A>&nbsp;server)
351                                 throws <A HREF="../../../../../../org/apache/solr/client/solrj/SolrServerException.html" title="class in org.apache.solr.client.solrj">SolrServerException</A>,
352                                        <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
353<DL>
354<DD>
355<P>
356<DD><DL>
357<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html#process(org.apache.solr.client.solrj.SolrServer)">process</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrRequest.html" title="class in org.apache.solr.client.solrj">SolrRequest</A></CODE></DL>
358</DD>
359<DD><DL>
360
361<DT><B>Throws:</B>
362<DD><CODE><A HREF="../../../../../../org/apache/solr/client/solrj/SolrServerException.html" title="class in org.apache.solr.client.solrj">SolrServerException</A></CODE>
363<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
364</DD>
365</DL>
366<HR>
367
368<A NAME="addDocument(org.apache.solr.common.SolrInputDocument)"><!-- --></A><H3>
369addDocument</H3>
370<PRE>
371public <A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A> <B>addDocument</B>(<A HREF="../../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&nbsp;doc)</PRE>
372<DL>
373<DD>Adds a document to be analyzed.
374<P>
375<DD><DL>
376<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The document to be analyzed.
377<DT><B>Returns:</B><DD>This DocumentAnalysisRequest (fluent interface support).</DL>
378</DD>
379</DL>
380<HR>
381
382<A NAME="addDocuments(java.util.Collection)"><!-- --></A><H3>
383addDocuments</H3>
384<PRE>
385public <A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A> <B>addDocuments</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&gt;&nbsp;docs)</PRE>
386<DL>
387<DD>Adds a collection of documents to be analyzed.
388<P>
389<DD><DL>
390<DT><B>Parameters:</B><DD><CODE>docs</CODE> - The documents to be analyzed.
391<DT><B>Returns:</B><DD>This DocumentAnalysisRequest (fluent interface support).<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#addDocument(org.apache.solr.common.SolrInputDocument)"><CODE>addDocument(org.apache.solr.common.SolrInputDocument)</CODE></A></DL>
392</DD>
393</DL>
394<HR>
395
396<A NAME="setQuery(java.lang.String)"><!-- --></A><H3>
397setQuery</H3>
398<PRE>
399public <A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A> <B>setQuery</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;query)</PRE>
400<DL>
401<DD>Sets the query to be analyzed. By default the query is set to null, meaning no query analysis will be performed.
402<P>
403<DD><DL>
404<DT><B>Parameters:</B><DD><CODE>query</CODE> - The query to be analyzed.
405<DT><B>Returns:</B><DD>This DocumentAnalysisRequest (fluent interface support).</DL>
406</DD>
407</DL>
408<HR>
409
410<A NAME="setShowMatch(boolean)"><!-- --></A><H3>
411setShowMatch</H3>
412<PRE>
413public <A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request">DocumentAnalysisRequest</A> <B>setShowMatch</B>(boolean&nbsp;showMatch)</PRE>
414<DL>
415<DD>Sets whether index time tokens that match query time tokens should be marked as a "match". By default this is set
416 to <code>false</code>. Obviously, this flag is ignored if when the query is set to <code>null</code>.
417<P>
418<DD><DL>
419<DT><B>Parameters:</B><DD><CODE>showMatch</CODE> - Sets whether index time tokens that match query time tokens should be marked as a "match".
420<DT><B>Returns:</B><DD>This DocumentAnalysisRequest (fluent interface support).</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="getDocuments()"><!-- --></A><H3>
426getDocuments</H3>
427<PRE>
428public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&gt; <B>getDocuments</B>()</PRE>
429<DL>
430<DD>Returns all documents that will be analyzed when processing the request.
431<P>
432<DD><DL>
433
434<DT><B>Returns:</B><DD>All documents that will be analyzed when processing the request.<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#addDocument(org.apache.solr.common.SolrInputDocument)"><CODE>addDocument(org.apache.solr.common.SolrInputDocument)</CODE></A></DL>
435</DD>
436</DL>
437<HR>
438
439<A NAME="getQuery()"><!-- --></A><H3>
440getQuery</H3>
441<PRE>
442public <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>getQuery</B>()</PRE>
443<DL>
444<DD>Returns the query that will be analyzed when processing the request. May return <code>null</code> indicating that no
445 query time analysis is taking place.
446<P>
447<DD><DL>
448
449<DT><B>Returns:</B><DD>The query that will be analyzed when processing the request.<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#setQuery(java.lang.String)"><CODE>setQuery(String)</CODE></A></DL>
450</DD>
451</DL>
452<HR>
453
454<A NAME="isShowMatch()"><!-- --></A><H3>
455isShowMatch</H3>
456<PRE>
457public boolean <B>isShowMatch</B>()</PRE>
458<DL>
459<DD>Returns whether index time tokens that match query time tokens will be marked as a "match".
460<P>
461<DD><DL>
462
463<DT><B>Returns:</B><DD>Whether index time tokens that match query time tokens will be marked as a "match".<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html#setShowMatch(boolean)"><CODE>setShowMatch(boolean)</CODE></A></DL>
464</DD>
465</DL>
466<!-- ========= END OF CLASS DATA ========= -->
467<HR>
468
469
470<!-- ======= START OF BOTTOM NAVBAR ====== -->
471<A NAME="navbar_bottom"><!-- --></A>
472<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
473<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
474<TR>
475<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
476<A NAME="navbar_bottom_firstrow"><!-- --></A>
477<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
478  <TR ALIGN="center" VALIGN="top">
479  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
480  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
481  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
482  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DocumentAnalysisRequest.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
483  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
484  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
485  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
486  </TR>
487</TABLE>
488</TD>
489<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
490</EM>
491</TD>
492</TR>
493
494<TR>
495<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
496&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/request/DirectXmlRequest.html" title="class in org.apache.solr.client.solrj.request"><B>PREV CLASS</B></A>&nbsp;
497&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/request/FieldAnalysisRequest.html" title="class in org.apache.solr.client.solrj.request"><B>NEXT CLASS</B></A></FONT></TD>
498<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
499  <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/request/DocumentAnalysisRequest.html" target="_top"><B>FRAMES</B></A>  &nbsp;
500&nbsp;<A HREF="DocumentAnalysisRequest.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
501&nbsp;<SCRIPT type="text/javascript">
502  <!--
503  if(window==top) {
504    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
505  }
506  //-->
507</SCRIPT>
508<NOSCRIPT>
509  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
510</NOSCRIPT>
511
512
513</FONT></TD>
514</TR>
515<TR>
516<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
517  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.client.solrj.SolrRequest">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
518<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
519DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
520</TR>
521</TABLE>
522<A NAME="skip-navbar_bottom"></A>
523<!-- ======== END OF BOTTOM NAVBAR ======= -->
524
525<HR>
526
527          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
528          <script src='../../../../../../prettify.js' type='text/javascript'></script>
529          <script type='text/javascript'>
530            (function(){
531              var oldonload = window.onload;
532              if (typeof oldonload != 'function') {
533                window.onload = prettyPrint;
534              } else {
535                window.onload = function() {
536                  oldonload();
537                  prettyPrint();
538                }
539              }
540            })();
541          </script>
542       
543</BODY>
544</HTML>
Note: See TracBrowser for help on using the repository browser.