source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/common/params/AnalysisParams.html @ 7588

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

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8AnalysisParams (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="AnalysisParams (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/AnalysisParams.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;PREV CLASS&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/common/params/AppendedSolrParams.html" title="class in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/common/params/AnalysisParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="AnalysisParams.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;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</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.common.params</FONT>
92<BR>
93Interface AnalysisParams</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>AnalysisParams</B></DL>
97</PRE>
98
99<P>
100Defines the request parameters used by all analysis request handlers.
101<P>
102
103<P>
104<DL>
105<DT><B>Since:</B></DT>
106  <DD>solr 1.4</DD>
107</DL>
108<HR>
109
110<P>
111<!-- =========== FIELD SUMMARY =========== -->
112
113<A NAME="field_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Field Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/AnalysisParams.html#FIELD_NAME">FIELD_NAME</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Holds the value of the field which should be analyzed.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/AnalysisParams.html#FIELD_TYPE">FIELD_TYPE</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Holds a comma-separated list of field types that the analysis should be peformed for.</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/AnalysisParams.html#FIELD_VALUE">FIELD_VALUE</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Hodls a comma-separated list of field named that the analysis should be performed for.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/AnalysisParams.html#PREFIX">PREFIX</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The prefix for all parameters.</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/AnalysisParams.html#QUERY">QUERY</A></B></CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Holds the query to be analyzed.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/AnalysisParams.html#SHOW_MATCH">SHOW_MATCH</A></B></CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to <code>true</code> to indicate that the index tokens that match query tokens should be marked as "mateched".</TD>
166</TR>
167</TABLE>
168&nbsp;
169<P>
170
171<!-- ============ FIELD DETAIL =========== -->
172
173<A NAME="field_detail"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
176<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
177<B>Field Detail</B></FONT></TH>
178</TR>
179</TABLE>
180
181<A NAME="PREFIX"><!-- --></A><H3>
182PREFIX</H3>
183<PRE>
184static final <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>PREFIX</B></PRE>
185<DL>
186<DD>The prefix for all parameters.
187<P>
188<DL>
189<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.AnalysisParams.PREFIX">Constant Field Values</A></DL>
190</DL>
191<HR>
192
193<A NAME="QUERY"><!-- --></A><H3>
194QUERY</H3>
195<PRE>
196static final <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>QUERY</B></PRE>
197<DL>
198<DD>Holds the query to be analyzed.
199<P>
200<DL>
201<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.AnalysisParams.QUERY">Constant Field Values</A></DL>
202</DL>
203<HR>
204
205<A NAME="SHOW_MATCH"><!-- --></A><H3>
206SHOW_MATCH</H3>
207<PRE>
208static final <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>SHOW_MATCH</B></PRE>
209<DL>
210<DD>Set to <code>true</code> to indicate that the index tokens that match query tokens should be marked as "mateched".
211<P>
212<DL>
213<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.AnalysisParams.SHOW_MATCH">Constant Field Values</A></DL>
214</DL>
215<HR>
216
217<A NAME="FIELD_NAME"><!-- --></A><H3>
218FIELD_NAME</H3>
219<PRE>
220static final <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>FIELD_NAME</B></PRE>
221<DL>
222<DD>Holds the value of the field which should be analyzed.
223<P>
224<DL>
225<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.AnalysisParams.FIELD_NAME">Constant Field Values</A></DL>
226</DL>
227<HR>
228
229<A NAME="FIELD_TYPE"><!-- --></A><H3>
230FIELD_TYPE</H3>
231<PRE>
232static final <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>FIELD_TYPE</B></PRE>
233<DL>
234<DD>Holds a comma-separated list of field types that the analysis should be peformed for.
235<P>
236<DL>
237<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.AnalysisParams.FIELD_TYPE">Constant Field Values</A></DL>
238</DL>
239<HR>
240
241<A NAME="FIELD_VALUE"><!-- --></A><H3>
242FIELD_VALUE</H3>
243<PRE>
244static final <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>FIELD_VALUE</B></PRE>
245<DL>
246<DD>Hodls a comma-separated list of field named that the analysis should be performed for.
247<P>
248<DL>
249<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.AnalysisParams.FIELD_VALUE">Constant Field Values</A></DL>
250</DL>
251<!-- ========= END OF CLASS DATA ========= -->
252<HR>
253
254
255<!-- ======= START OF BOTTOM NAVBAR ====== -->
256<A NAME="navbar_bottom"><!-- --></A>
257<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
258<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
259<TR>
260<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
261<A NAME="navbar_bottom_firstrow"><!-- --></A>
262<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
263  <TR ALIGN="center" VALIGN="top">
264  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
266  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
267  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AnalysisParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
268  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
269  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
270  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
271  </TR>
272</TABLE>
273</TD>
274<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
275</EM>
276</TD>
277</TR>
278
279<TR>
280<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
281&nbsp;PREV CLASS&nbsp;
282&nbsp;<A HREF="../../../../../org/apache/solr/common/params/AppendedSolrParams.html" title="class in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
283<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
284  <A HREF="../../../../../index.html?org/apache/solr/common/params/AnalysisParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
285&nbsp;<A HREF="AnalysisParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
286&nbsp;<SCRIPT type="text/javascript">
287  <!--
288  if(window==top) {
289    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
290  }
291  //-->
292</SCRIPT>
293<NOSCRIPT>
294  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
295</NOSCRIPT>
296
297
298</FONT></TD>
299</TR>
300<TR>
301<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
302  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
303<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
304DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
305</TR>
306</TABLE>
307<A NAME="skip-navbar_bottom"></A>
308<!-- ======== END OF BOTTOM NAVBAR ======= -->
309
310<HR>
311
312          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
313          <script src='../../../../../prettify.js' type='text/javascript'></script>
314          <script type='text/javascript'>
315            (function(){
316              var oldonload = window.onload;
317              if (typeof oldonload != 'function') {
318                window.onload = prettyPrint;
319              } else {
320                window.onload = function() {
321                  oldonload();
322                  prettyPrint();
323                }
324              }
325            })();
326          </script>
327       
328</BODY>
329</HTML>
Note: See TracBrowser for help on using the repository browser.