source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html @ 7588

Revision 7588, 17.1 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>
8AnalysisResponseBase.TokenInfo (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="AnalysisResponseBase.TokenInfo (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/AnalysisResponseBase.TokenInfo.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/response/AnalysisResponseBase.AnalysisPhase.html" title="class in org.apache.solr.client.solrj.response"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/CoreAdminResponse.html" title="class in org.apache.solr.client.solrj.response"><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/response/AnalysisResponseBase.TokenInfo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="AnalysisResponseBase.TokenInfo.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.response</FONT>
92<BR>
93Class AnalysisResponseBase.TokenInfo</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 "><B>org.apache.solr.client.solrj.response.AnalysisResponseBase.TokenInfo</B>
97</PRE>
98<DL>
99<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.html" title="class in org.apache.solr.client.solrj.response">AnalysisResponseBase</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public static class <B>AnalysisResponseBase.TokenInfo</B><DT>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></DL>
104</PRE>
105
106<P>
107Holds all information of a token as part of an analysis phase.
108<P>
109
110<P>
111<HR>
112
113<P>
114
115<!-- ========== METHOD SUMMARY =========== -->
116
117<A NAME="method_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Method Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;int</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#getEnd()">getEnd</A></B>()</CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the end position of this token within the text it was originally extracted from.</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;int</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#getPosition()">getPosition</A></B>()</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the position of this token within the produced token stream.</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<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>
142<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#getRawText()">getRawText</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the raw text of the token.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;int</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#getStart()">getStart</A></B>()</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the start position of this token within the text it was originally extracted from.</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<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>
158<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#getText()">getText</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the text of the token.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<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>
166<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#getType()">getType</A></B>()</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the type of the token.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>&nbsp;boolean</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html#isMatch()">isMatch</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether this token matches one of the query tokens (if query analysis is performed).</TD>
178</TR>
179</TABLE>
180&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183<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>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<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>
187</TR>
188</TABLE>
189&nbsp;
190<P>
191
192<!-- ============ METHOD DETAIL ========== -->
193
194<A NAME="method_detail"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
197<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
198<B>Method Detail</B></FONT></TH>
199</TR>
200</TABLE>
201
202<A NAME="getText()"><!-- --></A><H3>
203getText</H3>
204<PRE>
205public <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>getText</B>()</PRE>
206<DL>
207<DD>Returns the text of the token.
208<P>
209<DD><DL>
210
211<DT><B>Returns:</B><DD>The text of the token.</DL>
212</DD>
213</DL>
214<HR>
215
216<A NAME="getRawText()"><!-- --></A><H3>
217getRawText</H3>
218<PRE>
219public <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>getRawText</B>()</PRE>
220<DL>
221<DD>Returns the raw text of the token. If the token is index in a special format (e.g. date or paddded numbers)
222 it will be returned as the raw text. Returns <code>null</code> if the token is indexed as is.
223<P>
224<DD><DL>
225
226<DT><B>Returns:</B><DD>Returns the raw text of the token.</DL>
227</DD>
228</DL>
229<HR>
230
231<A NAME="getType()"><!-- --></A><H3>
232getType</H3>
233<PRE>
234public <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>getType</B>()</PRE>
235<DL>
236<DD>Returns the type of the token. Typically this will be <code>word</code> or <code>&lt;ALPHANUM&gt;</code>, but it really
237 depends on the tokenizer and filters that are used.
238<P>
239<DD><DL>
240
241<DT><B>Returns:</B><DD>The type of the token.</DL>
242</DD>
243</DL>
244<HR>
245
246<A NAME="getStart()"><!-- --></A><H3>
247getStart</H3>
248<PRE>
249public int <B>getStart</B>()</PRE>
250<DL>
251<DD>Returns the start position of this token within the text it was originally extracted from.
252<P>
253<DD><DL>
254
255<DT><B>Returns:</B><DD>The start position of this token within the text it was originally extracted from.</DL>
256</DD>
257</DL>
258<HR>
259
260<A NAME="getEnd()"><!-- --></A><H3>
261getEnd</H3>
262<PRE>
263public int <B>getEnd</B>()</PRE>
264<DL>
265<DD>Returns the end position of this token within the text it was originally extracted from.
266<P>
267<DD><DL>
268
269<DT><B>Returns:</B><DD>The end position of this token within the text it was originally extracted from.</DL>
270</DD>
271</DL>
272<HR>
273
274<A NAME="getPosition()"><!-- --></A><H3>
275getPosition</H3>
276<PRE>
277public int <B>getPosition</B>()</PRE>
278<DL>
279<DD>Returns the position of this token within the produced token stream.
280<P>
281<DD><DL>
282
283<DT><B>Returns:</B><DD>The position of this token within the produced token stream.</DL>
284</DD>
285</DL>
286<HR>
287
288<A NAME="isMatch()"><!-- --></A><H3>
289isMatch</H3>
290<PRE>
291public boolean <B>isMatch</B>()</PRE>
292<DL>
293<DD>Returns whether this token matches one of the query tokens (if query analysis is performed).
294<P>
295<DD><DL>
296
297<DT><B>Returns:</B><DD>Whether this token matches one of the query tokens (if query analysis is performed).</DL>
298</DD>
299</DL>
300<!-- ========= END OF CLASS DATA ========= -->
301<HR>
302
303
304<!-- ======= START OF BOTTOM NAVBAR ====== -->
305<A NAME="navbar_bottom"><!-- --></A>
306<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
307<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
308<TR>
309<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
310<A NAME="navbar_bottom_firstrow"><!-- --></A>
311<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
312  <TR ALIGN="center" VALIGN="top">
313  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
314  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
315  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
316  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AnalysisResponseBase.TokenInfo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
317  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
318  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
319  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
320  </TR>
321</TABLE>
322</TD>
323<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
324</EM>
325</TD>
326</TR>
327
328<TR>
329<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
330&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/AnalysisResponseBase.AnalysisPhase.html" title="class in org.apache.solr.client.solrj.response"><B>PREV CLASS</B></A>&nbsp;
331&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/CoreAdminResponse.html" title="class in org.apache.solr.client.solrj.response"><B>NEXT CLASS</B></A></FONT></TD>
332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
333  <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/response/AnalysisResponseBase.TokenInfo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
334&nbsp;<A HREF="AnalysisResponseBase.TokenInfo.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
335&nbsp;<SCRIPT type="text/javascript">
336  <!--
337  if(window==top) {
338    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
339  }
340  //-->
341</SCRIPT>
342<NOSCRIPT>
343  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
344</NOSCRIPT>
345
346
347</FONT></TD>
348</TR>
349<TR>
350<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
351  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
352<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
353DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
354</TR>
355</TABLE>
356<A NAME="skip-navbar_bottom"></A>
357<!-- ======== END OF BOTTOM NAVBAR ======= -->
358
359<HR>
360
361          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
362          <script src='../../../../../../prettify.js' type='text/javascript'></script>
363          <script type='text/javascript'>
364            (function(){
365              var oldonload = window.onload;
366              if (typeof oldonload != 'function') {
367                window.onload = prettyPrint;
368              } else {
369                window.onload = function() {
370                  oldonload();
371                  prettyPrint();
372                }
373              }
374            })();
375          </script>
376       
377</BODY>
378</HTML>
Note: See TracBrowser for help on using the repository browser.