source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/DocIterator.html @ 7588

Revision 7588, 11.2 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:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8DocIterator (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="DocIterator (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/DocIterator.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/search/DisMaxQParserPlugin.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/search/DocIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DocIterator.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.search</FONT>
92<BR>
93Interface DocIterator</H2>
94<DL>
95<DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&gt;</DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public interface <B>DocIterator</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&gt;</DL>
100</PRE>
101
102<P>
103Simple Iterator of document Ids which may include score information.
104
105 <p>
106 The order of the documents is determined by the context in which the
107 DocIterator instance was retrieved.
108 </p>
109<P>
110
111<P>
112<HR>
113
114<P>
115
116<!-- ========== METHOD SUMMARY =========== -->
117
118<A NAME="method_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
122<B>Method Summary</B></FONT></TH>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>&nbsp;int</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocIterator.html#nextDoc()">nextDoc</A></B>()</CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next document id if hasNext()==true
131
132 <code>
133 This method is equivalent to <code>next()</code>, but avoids the creation
134 of an Integer Object.</TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>&nbsp;float</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocIterator.html#score()">score</A></B>()</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the score for the document just returned by <code>nextDoc()</code></TD>
143</TR>
144</TABLE>
145&nbsp;<A NAME="methods_inherited_from_class_java.util.Iterator"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
148<TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></B></TH>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util">hasNext</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util">next</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#remove()" title="class or interface in java.util">remove</A></CODE></TD>
152</TR>
153</TABLE>
154&nbsp;
155<P>
156
157<!-- ============ METHOD DETAIL ========== -->
158
159<A NAME="method_detail"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
163<B>Method Detail</B></FONT></TH>
164</TR>
165</TABLE>
166
167<A NAME="nextDoc()"><!-- --></A><H3>
168nextDoc</H3>
169<PRE>
170int <B>nextDoc</B>()</PRE>
171<DL>
172<DD>Returns the next document id if hasNext()==true
173
174 <code>
175 This method is equivalent to <code>next()</code>, but avoids the creation
176 of an Integer Object.
177<P>
178<DD><DL>
179</DL>
180</DD>
181<DD><DL>
182<DT><B>See Also:</B><DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util"><CODE>Iterator.next()</CODE></A></DL>
183</DD>
184</DL>
185<HR>
186
187<A NAME="score()"><!-- --></A><H3>
188score</H3>
189<PRE>
190float <B>score</B>()</PRE>
191<DL>
192<DD>Returns the score for the document just returned by <code>nextDoc()</code>
193
194 <p>
195 The value returned may be meaningless depending on the context
196 in which the DocIterator instance was retrieved.
197<P>
198<DD><DL>
199</DL>
200</DD>
201<DD><DL>
202</DL>
203</DD>
204</DL>
205<!-- ========= END OF CLASS DATA ========= -->
206<HR>
207
208
209<!-- ======= START OF BOTTOM NAVBAR ====== -->
210<A NAME="navbar_bottom"><!-- --></A>
211<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
212<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
213<TR>
214<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
215<A NAME="navbar_bottom_firstrow"><!-- --></A>
216<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
217  <TR ALIGN="center" VALIGN="top">
218  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
219  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
220  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
221  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DocIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
222  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
223  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
224  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
225  </TR>
226</TABLE>
227</TD>
228<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
229</EM>
230</TD>
231</TR>
232
233<TR>
234<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
235&nbsp;<A HREF="../../../../org/apache/solr/search/DisMaxQParserPlugin.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
236&nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
237<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
238  <A HREF="../../../../index.html?org/apache/solr/search/DocIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
239&nbsp;<A HREF="DocIterator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
240&nbsp;<SCRIPT type="text/javascript">
241  <!--
242  if(window==top) {
243    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
244  }
245  //-->
246</SCRIPT>
247<NOSCRIPT>
248  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
249</NOSCRIPT>
250
251
252</FONT></TD>
253</TR>
254<TR>
255<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
256  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
257<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
258DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
259</TR>
260</TABLE>
261<A NAME="skip-navbar_bottom"></A>
262<!-- ======== END OF BOTTOM NAVBAR ======= -->
263
264<HR>
265
266          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
267          <script src='../../../../prettify.js' type='text/javascript'></script>
268          <script type='text/javascript'>
269            (function(){
270              var oldonload = window.onload;
271              if (typeof oldonload != 'function') {
272                window.onload = prettyPrint;
273              } else {
274                window.onload = function() {
275                  oldonload();
276                  prettyPrint();
277                }
278              }
279            })();
280          </script>
281       
282</BODY>
283</HTML>
Note: See TracBrowser for help on using the repository browser.