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

Revision 7588, 45.7 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>
8DocSlice (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="DocSlice (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/DocSlice.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/DocSetDelegateCollector.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/ExtendedDismaxQParserPlugin.html" title="class 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/DocSlice.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DocSlice.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;<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.search</FONT>
92<BR>
93Class DocSlice</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.search.DocSlice</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>DocSlice</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><DT>implements <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></DL>
104</PRE>
105
106<P>
107<code>DocSlice</code> implements DocList as an array of docids and optional scores.
108<P>
109
110<P>
111<DL>
112<DT><B>Since:</B></DT>
113  <DD>solr 0.9</DD>
114</DL>
115<HR>
116
117<P>
118<!-- =========== FIELD SUMMARY =========== -->
119
120<A NAME="field_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
124<B>Field Summary</B></FONT></TH>
125</TR>
126</TABLE>
127&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.search.DocSet"><!-- --></A>
128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
130<TH ALIGN="left"><B>Fields inherited from interface org.apache.solr.search.<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></B></TH>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#EMPTY">EMPTY</A></CODE></TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- ======== CONSTRUCTOR SUMMARY ======== -->
138
139<A NAME="constructor_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143<B>Constructor Summary</B></FONT></TH>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#DocSlice(int, int, int[], float[], int, float)">DocSlice</A></B>(int&nbsp;offset,
147         int&nbsp;len,
148         int[]&nbsp;docs,
149         float[]&nbsp;scores,
150         int&nbsp;matches,
151         float&nbsp;maxScore)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Primary constructor for a DocSlice instance.</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ========== METHOD SUMMARY =========== -->
159
160<A NAME="method_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
164<B>Method Summary</B></FONT></TH>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#add(int)">add</A></B>(int&nbsp;doc)</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the specified document if it is not currently in the DocSet
173 (optional operation).</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;void</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#addUnique(int)">addUnique</A></B>(int&nbsp;doc)</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a document the caller knows is not currently in the DocSet
182 (optional operation).</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#andNot(org.apache.solr.search.DocSet)">andNot</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the documents in this set that are not in the other set.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;int</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#andNotSize(org.apache.solr.search.DocSet)">andNotSize</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of documents in this set that are not in the other set.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>protected &nbsp;<A HREF="../../../../org/apache/solr/search/DocSlice.html" title="class in org.apache.solr.search">DocSlice</A></CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#clone()">clone</A></B>()</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&nbsp;boolean</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#equals(java.lang.Object)">equals</A></B>(<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>&nbsp;obj)</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>&nbsp;boolean</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#exists(int)">exists</A></B>(int&nbsp;doc)</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if a document is in the DocSet.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/OpenBitSet.html?is-external=true" title="class or interface in org.apache.lucene.util">OpenBitSet</A></CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#getBits()">getBits</A></B>()</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inefficient base implementation.</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Filter.html?is-external=true" title="class or interface in org.apache.lucene.search">Filter</A></CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#getTopFilter()">getTopFilter</A></B>()</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Filter for use in Lucene search methods, assuming this DocSet
239 was generated from the top-level MultiReader that the Lucene search
240 methods will be invoked with.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;boolean</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#hasScores()">hasScores</A></B>()</CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if scores were retained</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#intersection(org.apache.solr.search.DocSet)">intersection</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the intersection of this set with another set.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>&nbsp;int</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#intersectionSize(org.apache.solr.search.DocSet)">intersectionSize</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
262
263<BR>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of documents of the intersection of this set with another set.</TD>
265</TR>
266<TR BGCOLOR="white" CLASS="TableRowColor">
267<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268<CODE>&nbsp;boolean</CODE></FONT></TD>
269<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#intersects(org.apache.solr.search.DocSet)">intersects</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
270
271<BR>
272&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if these sets have any elements in common</TD>
273</TR>
274<TR BGCOLOR="white" CLASS="TableRowColor">
275<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/DocIterator.html" title="interface in org.apache.solr.search">DocIterator</A></CODE></FONT></TD>
277<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#iterator()">iterator</A></B>()</CODE>
278
279<BR>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an iterator that may be used to iterate over the documents in this DocList</TD>
281</TR>
282<TR BGCOLOR="white" CLASS="TableRowColor">
283<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284<CODE>&nbsp;int</CODE></FONT></TD>
285<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#matches()">matches</A></B>()</CODE>
286
287<BR>
288&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of matches for the search
289 (as opposed to just the number collected according
290 to <code>offset()</code> and <code>size()</code>).</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;float</CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#maxScore()">maxScore</A></B>()</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The maximum score for the search...</TD>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302<CODE>&nbsp;long</CODE></FONT></TD>
303<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#memSize()">memSize</A></B>()</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the approximate amount of memory taken by this DocSet.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>&nbsp;int</CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#offset()">offset</A></B>()</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the zero based offset of this list within the total ordered list of matches to the query.</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>&nbsp;void</CODE></FONT></TD>
319<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#setBitsOn(org.apache.lucene.util.OpenBitSet)">setBitsOn</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/OpenBitSet.html?is-external=true" title="class or interface in org.apache.lucene.util">OpenBitSet</A>&nbsp;target)</CODE>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Takes the docs from this set and sets those bits on the target OpenBitSet.</TD>
323</TR>
324<TR BGCOLOR="white" CLASS="TableRowColor">
325<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
326<CODE>&nbsp;int</CODE></FONT></TD>
327<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#size()">size</A></B>()</CODE>
328
329<BR>
330&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of ids in this list.</TD>
331</TR>
332<TR BGCOLOR="white" CLASS="TableRowColor">
333<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
334<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></FONT></TD>
335<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#subset(int, int)">subset</A></B>(int&nbsp;offset,
336       int&nbsp;len)</CODE>
337
338<BR>
339&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a subset of an existing DocList.</TD>
340</TR>
341<TR BGCOLOR="white" CLASS="TableRowColor">
342<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
343<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD>
344<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#union(org.apache.solr.search.DocSet)">union</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
345
346<BR>
347&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the union of this set with another set.</TD>
348</TR>
349<TR BGCOLOR="white" CLASS="TableRowColor">
350<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
351<CODE>&nbsp;int</CODE></FONT></TD>
352<TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSlice.html#unionSize(org.apache.solr.search.DocSet)">unionSize</A></B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</CODE>
353
354<BR>
355&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of documents of the union of this set with another set.</TD>
356</TR>
357</TABLE>
358&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
359<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
360<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
361<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>
362</TR>
363<TR BGCOLOR="white" CLASS="TableRowColor">
364<TD><CODE><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>
365</TR>
366</TABLE>
367&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.search.DocSet"><!-- --></A>
368<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
369<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
370<TH ALIGN="left"><B>Methods inherited from interface org.apache.solr.search.<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></B></TH>
371</TR>
372<TR BGCOLOR="white" CLASS="TableRowColor">
373<TD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#add(int)">add</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#addUnique(int)">addUnique</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#andNot(org.apache.solr.search.DocSet)">andNot</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#andNotSize(org.apache.solr.search.DocSet)">andNotSize</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#getBits()">getBits</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#getTopFilter()">getTopFilter</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#setBitsOn(org.apache.lucene.util.OpenBitSet)">setBitsOn</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#union(org.apache.solr.search.DocSet)">union</A>, <A HREF="../../../../org/apache/solr/search/DocSet.html#unionSize(org.apache.solr.search.DocSet)">unionSize</A></CODE></TD>
374</TR>
375</TABLE>
376&nbsp;
377<P>
378
379<!-- ========= CONSTRUCTOR DETAIL ======== -->
380
381<A NAME="constructor_detail"><!-- --></A>
382<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
383<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
384<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
385<B>Constructor Detail</B></FONT></TH>
386</TR>
387</TABLE>
388
389<A NAME="DocSlice(int, int, int[], float[], int, float)"><!-- --></A><H3>
390DocSlice</H3>
391<PRE>
392public <B>DocSlice</B>(int&nbsp;offset,
393                int&nbsp;len,
394                int[]&nbsp;docs,
395                float[]&nbsp;scores,
396                int&nbsp;matches,
397                float&nbsp;maxScore)</PRE>
398<DL>
399<DD>Primary constructor for a DocSlice instance.
400<P>
401<DL>
402<DT><B>Parameters:</B><DD><CODE>offset</CODE> - starting offset for this range of docs<DD><CODE>len</CODE> - length of results<DD><CODE>docs</CODE> - array of docids starting at position 0<DD><CODE>scores</CODE> - array of scores that corresponds to docs, may be null<DD><CODE>matches</CODE> - total number of matches for the query</DL>
403</DL>
404
405<!-- ============ METHOD DETAIL ========== -->
406
407<A NAME="method_detail"><!-- --></A>
408<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
409<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
410<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
411<B>Method Detail</B></FONT></TH>
412</TR>
413</TABLE>
414
415<A NAME="subset(int, int)"><!-- --></A><H3>
416subset</H3>
417<PRE>
418public <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> <B>subset</B>(int&nbsp;offset,
419                      int&nbsp;len)</PRE>
420<DL>
421<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#subset(int, int)">DocList</A></CODE></B></DD>
422<DD>Get a subset of an existing DocList.
423 Returns null if not possible.
424<P>
425<DD><DL>
426<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#subset(int, int)">subset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></DL>
427</DD>
428<DD><DL>
429</DL>
430</DD>
431</DL>
432<HR>
433
434<A NAME="hasScores()"><!-- --></A><H3>
435hasScores</H3>
436<PRE>
437public boolean <B>hasScores</B>()</PRE>
438<DL>
439<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#hasScores()">DocList</A></CODE></B></DD>
440<DD>True if scores were retained
441<P>
442<DD><DL>
443<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#hasScores()">hasScores</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></DL>
444</DD>
445<DD><DL>
446</DL>
447</DD>
448</DL>
449<HR>
450
451<A NAME="maxScore()"><!-- --></A><H3>
452maxScore</H3>
453<PRE>
454public float <B>maxScore</B>()</PRE>
455<DL>
456<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#maxScore()">DocList</A></CODE></B></DD>
457<DD>The maximum score for the search... only valid if
458 scores were retained (if hasScores()==true)
459<P>
460<DD><DL>
461<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#maxScore()">maxScore</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></DL>
462</DD>
463<DD><DL>
464</DL>
465</DD>
466</DL>
467<HR>
468
469<A NAME="offset()"><!-- --></A><H3>
470offset</H3>
471<PRE>
472public int <B>offset</B>()</PRE>
473<DL>
474<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#offset()">DocList</A></CODE></B></DD>
475<DD>Returns the zero based offset of this list within the total ordered list of matches to the query.
476<P>
477<DD><DL>
478<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#offset()">offset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></DL>
479</DD>
480<DD><DL>
481</DL>
482</DD>
483</DL>
484<HR>
485
486<A NAME="size()"><!-- --></A><H3>
487size</H3>
488<PRE>
489public int <B>size</B>()</PRE>
490<DL>
491<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#size()">DocList</A></CODE></B></DD>
492<DD>Returns the number of ids in this list.
493<P>
494<DD><DL>
495<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#size()">size</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#size()">size</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
496</DD>
497<DD><DL>
498</DL>
499</DD>
500</DL>
501<HR>
502
503<A NAME="matches()"><!-- --></A><H3>
504matches</H3>
505<PRE>
506public int <B>matches</B>()</PRE>
507<DL>
508<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#matches()">DocList</A></CODE></B></DD>
509<DD>Returns the total number of matches for the search
510 (as opposed to just the number collected according
511 to <code>offset()</code> and <code>size()</code>).
512 Hence it's always true that matches() >= size()
513<P>
514<DD><DL>
515<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#matches()">matches</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></DL>
516</DD>
517<DD><DL>
518
519<DT><B>Returns:</B><DD>number of matches for the search(query &amp; any filters)</DL>
520</DD>
521</DL>
522<HR>
523
524<A NAME="memSize()"><!-- --></A><H3>
525memSize</H3>
526<PRE>
527public long <B>memSize</B>()</PRE>
528<DL>
529<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#memSize()">DocSet</A></CODE></B></DD>
530<DD>Returns the approximate amount of memory taken by this DocSet.
531 This is only an approximation and doesn't take into account java object overhead.
532<P>
533<DD><DL>
534<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#memSize()">memSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
535</DD>
536<DD><DL>
537
538<DT><B>Returns:</B><DD>the approximate memory consumption in bytes</DL>
539</DD>
540</DL>
541<HR>
542
543<A NAME="exists(int)"><!-- --></A><H3>
544exists</H3>
545<PRE>
546public boolean <B>exists</B>(int&nbsp;doc)</PRE>
547<DL>
548<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#exists(int)">DocSet</A></CODE></B></DD>
549<DD>Returns true if a document is in the DocSet.
550<P>
551<DD><DL>
552<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#exists(int)">exists</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
553</DD>
554<DD><DL>
555</DL>
556</DD>
557</DL>
558<HR>
559
560<A NAME="iterator()"><!-- --></A><H3>
561iterator</H3>
562<PRE>
563public <A HREF="../../../../org/apache/solr/search/DocIterator.html" title="interface in org.apache.solr.search">DocIterator</A> <B>iterator</B>()</PRE>
564<DL>
565<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocList.html#iterator()">DocList</A></CODE></B></DD>
566<DD>Returns an iterator that may be used to iterate over the documents in this DocList
567
568 <p>
569 The order of the documents returned by this iterator is based on the
570 Sort order of the search that produced it.  The Scoring information
571 is meaningful only if <code>hasScores()</code> returns true.
572 </p>
573<P>
574<DD><DL>
575<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocList.html#iterator()">iterator</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#iterator()">iterator</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
576</DD>
577<DD><DL>
578<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/DocList.html#hasScores()"><CODE>DocList.hasScores()</CODE></A></DL>
579</DD>
580</DL>
581<HR>
582
583<A NAME="intersection(org.apache.solr.search.DocSet)"><!-- --></A><H3>
584intersection</H3>
585<PRE>
586public <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> <B>intersection</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
587<DL>
588<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#intersection(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
589<DD>Returns the intersection of this set with another set.  Neither set is modified - a new DocSet is
590 created and returned.
591<P>
592<DD><DL>
593<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#intersection(org.apache.solr.search.DocSet)">intersection</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
594</DD>
595<DD><DL>
596
597<DT><B>Returns:</B><DD>a DocSet representing the intersection</DL>
598</DD>
599</DL>
600<HR>
601
602<A NAME="intersectionSize(org.apache.solr.search.DocSet)"><!-- --></A><H3>
603intersectionSize</H3>
604<PRE>
605public int <B>intersectionSize</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
606<DL>
607<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#intersectionSize(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
608<DD>Returns the number of documents of the intersection of this set with another set.
609 May be more efficient than actually creating the intersection and then getting it's size.
610<P>
611<DD><DL>
612<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#intersectionSize(org.apache.solr.search.DocSet)">intersectionSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
613</DD>
614<DD><DL>
615</DL>
616</DD>
617</DL>
618<HR>
619
620<A NAME="intersects(org.apache.solr.search.DocSet)"><!-- --></A><H3>
621intersects</H3>
622<PRE>
623public boolean <B>intersects</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
624<DL>
625<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#intersects(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
626<DD>Returns true if these sets have any elements in common
627<P>
628<DD><DL>
629<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#intersects(org.apache.solr.search.DocSet)">intersects</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
630</DD>
631<DD><DL>
632</DL>
633</DD>
634</DL>
635<HR>
636
637<A NAME="clone()"><!-- --></A><H3>
638clone</H3>
639<PRE>
640protected <A HREF="../../../../org/apache/solr/search/DocSlice.html" title="class in org.apache.solr.search">DocSlice</A> <B>clone</B>()</PRE>
641<DL>
642<DD><DL>
643<DT><B>Overrides:</B><DD><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></CODE> in class <CODE><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></DL>
644</DD>
645<DD><DL>
646</DL>
647</DD>
648</DL>
649<HR>
650
651<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
652equals</H3>
653<PRE>
654public boolean <B>equals</B>(<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>&nbsp;obj)</PRE>
655<DL>
656<DD><DL>
657<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></DL>
658</DD>
659<DD><DL>
660</DL>
661</DD>
662</DL>
663<HR>
664
665<A NAME="add(int)"><!-- --></A><H3>
666add</H3>
667<PRE>
668public void <B>add</B>(int&nbsp;doc)</PRE>
669<DL>
670<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#add(int)">DocSet</A></CODE></B></DD>
671<DD>Adds the specified document if it is not currently in the DocSet
672 (optional operation).
673<P>
674<DD><DL>
675<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#add(int)">add</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
676</DD>
677<DD><DL>
678
679<DT><B>Throws:</B>
680<DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - Base implementation does not allow modifications<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/DocSet.html#addUnique(int)"><CODE>DocSet.addUnique(int)</CODE></A></DL>
681</DD>
682</DL>
683<HR>
684
685<A NAME="addUnique(int)"><!-- --></A><H3>
686addUnique</H3>
687<PRE>
688public void <B>addUnique</B>(int&nbsp;doc)</PRE>
689<DL>
690<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#addUnique(int)">DocSet</A></CODE></B></DD>
691<DD>Adds a document the caller knows is not currently in the DocSet
692 (optional operation).
693
694 <p>
695 This method may be faster then <code>add(doc)</code> in some
696 implementaions provided the caller is certain of the precondition.
697 </p>
698<P>
699<DD><DL>
700<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#addUnique(int)">addUnique</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
701</DD>
702<DD><DL>
703
704<DT><B>Throws:</B>
705<DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - Base implementation does not allow modifications<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/DocSet.html#add(int)"><CODE>DocSet.add(int)</CODE></A></DL>
706</DD>
707</DL>
708<HR>
709
710<A NAME="getBits()"><!-- --></A><H3>
711getBits</H3>
712<PRE>
713public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/OpenBitSet.html?is-external=true" title="class or interface in org.apache.lucene.util">OpenBitSet</A> <B>getBits</B>()</PRE>
714<DL>
715<DD>Inefficient base implementation.
716<P>
717<DD><DL>
718<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#getBits()">getBits</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
719</DD>
720<DD><DL>
721
722<DT><B>Returns:</B><DD>An OpenBitSet with the bit number of every docid set in the set.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/BitDocSet.html#getBits()"><CODE>BitDocSet.getBits()</CODE></A></DL>
723</DD>
724</DL>
725<HR>
726
727<A NAME="union(org.apache.solr.search.DocSet)"><!-- --></A><H3>
728union</H3>
729<PRE>
730public <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> <B>union</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
731<DL>
732<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#union(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
733<DD>Returns the union of this set with another set.  Neither set is modified - a new DocSet is
734 created and returned.
735<P>
736<DD><DL>
737<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#union(org.apache.solr.search.DocSet)">union</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
738</DD>
739<DD><DL>
740
741<DT><B>Returns:</B><DD>a DocSet representing the union</DL>
742</DD>
743</DL>
744<HR>
745
746<A NAME="unionSize(org.apache.solr.search.DocSet)"><!-- --></A><H3>
747unionSize</H3>
748<PRE>
749public int <B>unionSize</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
750<DL>
751<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#unionSize(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
752<DD>Returns the number of documents of the union of this set with another set.
753 May be more efficient than actually creating the union and then getting it's size.
754<P>
755<DD><DL>
756<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#unionSize(org.apache.solr.search.DocSet)">unionSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
757</DD>
758<DD><DL>
759</DL>
760</DD>
761</DL>
762<HR>
763
764<A NAME="andNot(org.apache.solr.search.DocSet)"><!-- --></A><H3>
765andNot</H3>
766<PRE>
767public <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> <B>andNot</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
768<DL>
769<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#andNot(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
770<DD>Returns the documents in this set that are not in the other set. Neither set is modified - a new DocSet is
771 created and returned.
772<P>
773<DD><DL>
774<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#andNot(org.apache.solr.search.DocSet)">andNot</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
775</DD>
776<DD><DL>
777
778<DT><B>Returns:</B><DD>a DocSet representing this AND NOT other</DL>
779</DD>
780</DL>
781<HR>
782
783<A NAME="andNotSize(org.apache.solr.search.DocSet)"><!-- --></A><H3>
784andNotSize</H3>
785<PRE>
786public int <B>andNotSize</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A>&nbsp;other)</PRE>
787<DL>
788<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#andNotSize(org.apache.solr.search.DocSet)">DocSet</A></CODE></B></DD>
789<DD>Returns the number of documents in this set that are not in the other set.
790<P>
791<DD><DL>
792<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#andNotSize(org.apache.solr.search.DocSet)">andNotSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
793</DD>
794<DD><DL>
795</DL>
796</DD>
797</DL>
798<HR>
799
800<A NAME="getTopFilter()"><!-- --></A><H3>
801getTopFilter</H3>
802<PRE>
803public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Filter.html?is-external=true" title="class or interface in org.apache.lucene.search">Filter</A> <B>getTopFilter</B>()</PRE>
804<DL>
805<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#getTopFilter()">DocSet</A></CODE></B></DD>
806<DD>Returns a Filter for use in Lucene search methods, assuming this DocSet
807 was generated from the top-level MultiReader that the Lucene search
808 methods will be invoked with.
809<P>
810<DD><DL>
811<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#getTopFilter()">getTopFilter</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
812</DD>
813<DD><DL>
814</DL>
815</DD>
816</DL>
817<HR>
818
819<A NAME="setBitsOn(org.apache.lucene.util.OpenBitSet)"><!-- --></A><H3>
820setBitsOn</H3>
821<PRE>
822public void <B>setBitsOn</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/OpenBitSet.html?is-external=true" title="class or interface in org.apache.lucene.util">OpenBitSet</A>&nbsp;target)</PRE>
823<DL>
824<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#setBitsOn(org.apache.lucene.util.OpenBitSet)">DocSet</A></CODE></B></DD>
825<DD>Takes the docs from this set and sets those bits on the target OpenBitSet.
826 The target should be sized large enough to accommodate all of the documents before calling this method.
827<P>
828<DD><DL>
829<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/DocSet.html#setBitsOn(org.apache.lucene.util.OpenBitSet)">setBitsOn</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></DL>
830</DD>
831<DD><DL>
832</DL>
833</DD>
834</DL>
835<!-- ========= END OF CLASS DATA ========= -->
836<HR>
837
838
839<!-- ======= START OF BOTTOM NAVBAR ====== -->
840<A NAME="navbar_bottom"><!-- --></A>
841<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
842<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
843<TR>
844<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
845<A NAME="navbar_bottom_firstrow"><!-- --></A>
846<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
847  <TR ALIGN="center" VALIGN="top">
848  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
849  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
850  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
851  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DocSlice.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
852  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
853  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
854  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
855  </TR>
856</TABLE>
857</TD>
858<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
859</EM>
860</TD>
861</TR>
862
863<TR>
864<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
865&nbsp;<A HREF="../../../../org/apache/solr/search/DocSetDelegateCollector.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
866&nbsp;<A HREF="../../../../org/apache/solr/search/ExtendedDismaxQParserPlugin.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
867<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
868  <A HREF="../../../../index.html?org/apache/solr/search/DocSlice.html" target="_top"><B>FRAMES</B></A>  &nbsp;
869&nbsp;<A HREF="DocSlice.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
870&nbsp;<SCRIPT type="text/javascript">
871  <!--
872  if(window==top) {
873    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
874  }
875  //-->
876</SCRIPT>
877<NOSCRIPT>
878  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
879</NOSCRIPT>
880
881
882</FONT></TD>
883</TR>
884<TR>
885<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
886  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
887<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
888DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
889</TR>
890</TABLE>
891<A NAME="skip-navbar_bottom"></A>
892<!-- ======== END OF BOTTOM NAVBAR ======= -->
893
894<HR>
895
896          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
897          <script src='../../../../prettify.js' type='text/javascript'></script>
898          <script type='text/javascript'>
899            (function(){
900              var oldonload = window.onload;
901              if (typeof oldonload != 'function') {
902                window.onload = prettyPrint;
903              } else {
904                window.onload = function() {
905                  oldonload();
906                  prettyPrint();
907                }
908              }
909            })();
910          </script>
911       
912</BODY>
913</HTML>
Note: See TracBrowser for help on using the repository browser.