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> |
---|
8 | DocSet (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"> |
---|
16 | function windowTitle() |
---|
17 | { |
---|
18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
19 | parent.document.title="DocSet (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> </TD> |
---|
42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DocSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../org/apache/solr/search/DocListAndSet.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../org/apache/solr/search/DocSetCollector.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/DocSet.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="DocSet.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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"> |
---|
91 | org.apache.solr.search</FONT> |
---|
92 | <BR> |
---|
93 | Interface DocSet</H2> |
---|
94 | <DL> |
---|
95 | <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></DD> |
---|
96 | </DL> |
---|
97 | <DL> |
---|
98 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/solr/search/BitDocSet.html" title="class in org.apache.solr.search">BitDocSet</A>, <A HREF="../../../../org/apache/solr/search/DocSlice.html" title="class in org.apache.solr.search">DocSlice</A>, <A HREF="../../../../org/apache/solr/search/HashDocSet.html" title="class in org.apache.solr.search">HashDocSet</A>, <A HREF="../../../../org/apache/solr/search/SortedIntDocSet.html" title="class in org.apache.solr.search">SortedIntDocSet</A></DD> |
---|
99 | </DL> |
---|
100 | <HR> |
---|
101 | <DL> |
---|
102 | <DT><PRE>public interface <B>DocSet</B></DL> |
---|
103 | </PRE> |
---|
104 | |
---|
105 | <P> |
---|
106 | <code>DocSet</code> represents an unordered set of Lucene Document Ids. |
---|
107 | |
---|
108 | <p> |
---|
109 | WARNING: Any DocSet returned from SolrIndexSearcher should <b>not</b> be modified as it may have been retrieved from |
---|
110 | a cache and could be shared. |
---|
111 | </p> |
---|
112 | <P> |
---|
113 | |
---|
114 | <P> |
---|
115 | <DL> |
---|
116 | <DT><B>Since:</B></DT> |
---|
117 | <DD>solr 0.9</DD> |
---|
118 | </DL> |
---|
119 | <HR> |
---|
120 | |
---|
121 | <P> |
---|
122 | <!-- =========== FIELD SUMMARY =========== --> |
---|
123 | |
---|
124 | <A NAME="field_summary"><!-- --></A> |
---|
125 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
126 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
127 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
128 | <B>Field Summary</B></FONT></TH> |
---|
129 | </TR> |
---|
130 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
131 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
132 | <CODE>static <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD> |
---|
133 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#EMPTY">EMPTY</A></B></CODE> |
---|
134 | |
---|
135 | <BR> |
---|
136 | </TD> |
---|
137 | </TR> |
---|
138 | </TABLE> |
---|
139 | |
---|
140 | <!-- ========== METHOD SUMMARY =========== --> |
---|
141 | |
---|
142 | <A NAME="method_summary"><!-- --></A> |
---|
143 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
144 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
145 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
146 | <B>Method Summary</B></FONT></TH> |
---|
147 | </TR> |
---|
148 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
149 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
150 | <CODE> void</CODE></FONT></TD> |
---|
151 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#add(int)">add</A></B>(int doc)</CODE> |
---|
152 | |
---|
153 | <BR> |
---|
154 | Adds the specified document if it is not currently in the DocSet |
---|
155 | (optional operation).</TD> |
---|
156 | </TR> |
---|
157 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
158 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
159 | <CODE> void</CODE></FONT></TD> |
---|
160 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#addUnique(int)">addUnique</A></B>(int doc)</CODE> |
---|
161 | |
---|
162 | <BR> |
---|
163 | Adds a document the caller knows is not currently in the DocSet |
---|
164 | (optional operation).</TD> |
---|
165 | </TR> |
---|
166 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
167 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
168 | <CODE> <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD> |
---|
169 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
170 | |
---|
171 | <BR> |
---|
172 | Returns the documents in this set that are not in the other set.</TD> |
---|
173 | </TR> |
---|
174 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
175 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
176 | <CODE> int</CODE></FONT></TD> |
---|
177 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
178 | |
---|
179 | <BR> |
---|
180 | Returns the number of documents in this set that are not in the other set.</TD> |
---|
181 | </TR> |
---|
182 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
183 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
184 | <CODE> boolean</CODE></FONT></TD> |
---|
185 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#exists(int)">exists</A></B>(int docid)</CODE> |
---|
186 | |
---|
187 | <BR> |
---|
188 | Returns true if a document is in the DocSet.</TD> |
---|
189 | </TR> |
---|
190 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
191 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
192 | <CODE> <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> |
---|
193 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#getBits()">getBits</A></B>()</CODE> |
---|
194 | |
---|
195 | <BR> |
---|
196 | Returns a BitSet view of the DocSet.</TD> |
---|
197 | </TR> |
---|
198 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
199 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
200 | <CODE> <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> |
---|
201 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#getTopFilter()">getTopFilter</A></B>()</CODE> |
---|
202 | |
---|
203 | <BR> |
---|
204 | Returns a Filter for use in Lucene search methods, assuming this DocSet |
---|
205 | was generated from the top-level MultiReader that the Lucene search |
---|
206 | methods will be invoked with.</TD> |
---|
207 | </TR> |
---|
208 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
209 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
210 | <CODE> <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD> |
---|
211 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
212 | |
---|
213 | <BR> |
---|
214 | Returns the intersection of this set with another set.</TD> |
---|
215 | </TR> |
---|
216 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
217 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
218 | <CODE> int</CODE></FONT></TD> |
---|
219 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
220 | |
---|
221 | <BR> |
---|
222 | Returns the number of documents of the intersection of this set with another set.</TD> |
---|
223 | </TR> |
---|
224 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
225 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
226 | <CODE> boolean</CODE></FONT></TD> |
---|
227 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
228 | |
---|
229 | <BR> |
---|
230 | Returns true if these sets have any elements in common</TD> |
---|
231 | </TR> |
---|
232 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
233 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
234 | <CODE> <A HREF="../../../../org/apache/solr/search/DocIterator.html" title="interface in org.apache.solr.search">DocIterator</A></CODE></FONT></TD> |
---|
235 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#iterator()">iterator</A></B>()</CODE> |
---|
236 | |
---|
237 | <BR> |
---|
238 | Returns an iterator that may be used to iterate over all of the documents in the set.</TD> |
---|
239 | </TR> |
---|
240 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
241 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
242 | <CODE> long</CODE></FONT></TD> |
---|
243 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#memSize()">memSize</A></B>()</CODE> |
---|
244 | |
---|
245 | <BR> |
---|
246 | Returns the approximate amount of memory taken by this DocSet.</TD> |
---|
247 | </TR> |
---|
248 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
249 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
250 | <CODE> void</CODE></FONT></TD> |
---|
251 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> target)</CODE> |
---|
252 | |
---|
253 | <BR> |
---|
254 | Takes the docs from this set and sets those bits on the target OpenBitSet.</TD> |
---|
255 | </TR> |
---|
256 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
257 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
258 | <CODE> int</CODE></FONT></TD> |
---|
259 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.html#size()">size</A></B>()</CODE> |
---|
260 | |
---|
261 | <BR> |
---|
262 | Returns the number of documents in the set.</TD> |
---|
263 | </TR> |
---|
264 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
265 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
266 | <CODE> <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A></CODE></FONT></TD> |
---|
267 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
268 | |
---|
269 | <BR> |
---|
270 | Returns the union of this set with another set.</TD> |
---|
271 | </TR> |
---|
272 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
273 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
274 | <CODE> int</CODE></FONT></TD> |
---|
275 | <TD><CODE><B><A HREF="../../../../org/apache/solr/search/DocSet.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> other)</CODE> |
---|
276 | |
---|
277 | <BR> |
---|
278 | Returns the number of documents of the union of this set with another set.</TD> |
---|
279 | </TR> |
---|
280 | </TABLE> |
---|
281 | |
---|
282 | <P> |
---|
283 | |
---|
284 | <!-- ============ FIELD DETAIL =========== --> |
---|
285 | |
---|
286 | <A NAME="field_detail"><!-- --></A> |
---|
287 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
288 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
289 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
290 | <B>Field Detail</B></FONT></TH> |
---|
291 | </TR> |
---|
292 | </TABLE> |
---|
293 | |
---|
294 | <A NAME="EMPTY"><!-- --></A><H3> |
---|
295 | EMPTY</H3> |
---|
296 | <PRE> |
---|
297 | static final <A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> <B>EMPTY</B></PRE> |
---|
298 | <DL> |
---|
299 | <DL> |
---|
300 | </DL> |
---|
301 | </DL> |
---|
302 | |
---|
303 | <!-- ============ METHOD DETAIL ========== --> |
---|
304 | |
---|
305 | <A NAME="method_detail"><!-- --></A> |
---|
306 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
307 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
308 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
309 | <B>Method Detail</B></FONT></TH> |
---|
310 | </TR> |
---|
311 | </TABLE> |
---|
312 | |
---|
313 | <A NAME="add(int)"><!-- --></A><H3> |
---|
314 | add</H3> |
---|
315 | <PRE> |
---|
316 | void <B>add</B>(int doc)</PRE> |
---|
317 | <DL> |
---|
318 | <DD>Adds the specified document if it is not currently in the DocSet |
---|
319 | (optional operation). |
---|
320 | <P> |
---|
321 | <DD><DL> |
---|
322 | |
---|
323 | <DT><B>Throws:</B> |
---|
324 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - if the implementation does not allow modifications<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/DocSet.html#addUnique(int)"><CODE>addUnique(int)</CODE></A></DL> |
---|
325 | </DD> |
---|
326 | </DL> |
---|
327 | <HR> |
---|
328 | |
---|
329 | <A NAME="addUnique(int)"><!-- --></A><H3> |
---|
330 | addUnique</H3> |
---|
331 | <PRE> |
---|
332 | void <B>addUnique</B>(int doc)</PRE> |
---|
333 | <DL> |
---|
334 | <DD>Adds a document the caller knows is not currently in the DocSet |
---|
335 | (optional operation). |
---|
336 | |
---|
337 | <p> |
---|
338 | This method may be faster then <code>add(doc)</code> in some |
---|
339 | implementaions provided the caller is certain of the precondition. |
---|
340 | </p> |
---|
341 | <P> |
---|
342 | <DD><DL> |
---|
343 | |
---|
344 | <DT><B>Throws:</B> |
---|
345 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - if the implementation does not allow modifications<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/search/DocSet.html#add(int)"><CODE>add(int)</CODE></A></DL> |
---|
346 | </DD> |
---|
347 | </DL> |
---|
348 | <HR> |
---|
349 | |
---|
350 | <A NAME="size()"><!-- --></A><H3> |
---|
351 | size</H3> |
---|
352 | <PRE> |
---|
353 | int <B>size</B>()</PRE> |
---|
354 | <DL> |
---|
355 | <DD>Returns the number of documents in the set. |
---|
356 | <P> |
---|
357 | <DD><DL> |
---|
358 | </DL> |
---|
359 | </DD> |
---|
360 | </DL> |
---|
361 | <HR> |
---|
362 | |
---|
363 | <A NAME="exists(int)"><!-- --></A><H3> |
---|
364 | exists</H3> |
---|
365 | <PRE> |
---|
366 | boolean <B>exists</B>(int docid)</PRE> |
---|
367 | <DL> |
---|
368 | <DD>Returns true if a document is in the DocSet. |
---|
369 | <P> |
---|
370 | <DD><DL> |
---|
371 | </DL> |
---|
372 | </DD> |
---|
373 | </DL> |
---|
374 | <HR> |
---|
375 | |
---|
376 | <A NAME="iterator()"><!-- --></A><H3> |
---|
377 | iterator</H3> |
---|
378 | <PRE> |
---|
379 | <A HREF="../../../../org/apache/solr/search/DocIterator.html" title="interface in org.apache.solr.search">DocIterator</A> <B>iterator</B>()</PRE> |
---|
380 | <DL> |
---|
381 | <DD>Returns an iterator that may be used to iterate over all of the documents in the set. |
---|
382 | |
---|
383 | <p> |
---|
384 | The order of the documents returned by this iterator is |
---|
385 | non-deterministic, and any scoring information is meaningless |
---|
386 | </p> |
---|
387 | <P> |
---|
388 | <DD><DL> |
---|
389 | </DL> |
---|
390 | </DD> |
---|
391 | </DL> |
---|
392 | <HR> |
---|
393 | |
---|
394 | <A NAME="getBits()"><!-- --></A><H3> |
---|
395 | getBits</H3> |
---|
396 | <PRE> |
---|
397 | <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> |
---|
398 | <DL> |
---|
399 | <DD>Returns a BitSet view of the DocSet. Any changes to this BitSet <b>may</b> |
---|
400 | be reflected in the DocSet, hence if the DocSet is shared or was returned from |
---|
401 | a SolrIndexSearcher method, it's not safe to modify the BitSet. |
---|
402 | <P> |
---|
403 | <DD><DL> |
---|
404 | |
---|
405 | <DT><B>Returns:</B><DD>An OpenBitSet with the bit number of every docid set in the set.</DL> |
---|
406 | </DD> |
---|
407 | </DL> |
---|
408 | <HR> |
---|
409 | |
---|
410 | <A NAME="memSize()"><!-- --></A><H3> |
---|
411 | memSize</H3> |
---|
412 | <PRE> |
---|
413 | long <B>memSize</B>()</PRE> |
---|
414 | <DL> |
---|
415 | <DD>Returns the approximate amount of memory taken by this DocSet. |
---|
416 | This is only an approximation and doesn't take into account java object overhead. |
---|
417 | <P> |
---|
418 | <DD><DL> |
---|
419 | |
---|
420 | <DT><B>Returns:</B><DD>the approximate memory consumption in bytes</DL> |
---|
421 | </DD> |
---|
422 | </DL> |
---|
423 | <HR> |
---|
424 | |
---|
425 | <A NAME="intersection(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
426 | intersection</H3> |
---|
427 | <PRE> |
---|
428 | <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> other)</PRE> |
---|
429 | <DL> |
---|
430 | <DD>Returns the intersection of this set with another set. Neither set is modified - a new DocSet is |
---|
431 | created and returned. |
---|
432 | <P> |
---|
433 | <DD><DL> |
---|
434 | |
---|
435 | <DT><B>Returns:</B><DD>a DocSet representing the intersection</DL> |
---|
436 | </DD> |
---|
437 | </DL> |
---|
438 | <HR> |
---|
439 | |
---|
440 | <A NAME="intersectionSize(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
441 | intersectionSize</H3> |
---|
442 | <PRE> |
---|
443 | int <B>intersectionSize</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> other)</PRE> |
---|
444 | <DL> |
---|
445 | <DD>Returns the number of documents of the intersection of this set with another set. |
---|
446 | May be more efficient than actually creating the intersection and then getting it's size. |
---|
447 | <P> |
---|
448 | <DD><DL> |
---|
449 | </DL> |
---|
450 | </DD> |
---|
451 | </DL> |
---|
452 | <HR> |
---|
453 | |
---|
454 | <A NAME="intersects(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
455 | intersects</H3> |
---|
456 | <PRE> |
---|
457 | boolean <B>intersects</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> other)</PRE> |
---|
458 | <DL> |
---|
459 | <DD>Returns true if these sets have any elements in common |
---|
460 | <P> |
---|
461 | <DD><DL> |
---|
462 | </DL> |
---|
463 | </DD> |
---|
464 | </DL> |
---|
465 | <HR> |
---|
466 | |
---|
467 | <A NAME="union(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
468 | union</H3> |
---|
469 | <PRE> |
---|
470 | <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> other)</PRE> |
---|
471 | <DL> |
---|
472 | <DD>Returns the union of this set with another set. Neither set is modified - a new DocSet is |
---|
473 | created and returned. |
---|
474 | <P> |
---|
475 | <DD><DL> |
---|
476 | |
---|
477 | <DT><B>Returns:</B><DD>a DocSet representing the union</DL> |
---|
478 | </DD> |
---|
479 | </DL> |
---|
480 | <HR> |
---|
481 | |
---|
482 | <A NAME="unionSize(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
483 | unionSize</H3> |
---|
484 | <PRE> |
---|
485 | int <B>unionSize</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> other)</PRE> |
---|
486 | <DL> |
---|
487 | <DD>Returns the number of documents of the union of this set with another set. |
---|
488 | May be more efficient than actually creating the union and then getting it's size. |
---|
489 | <P> |
---|
490 | <DD><DL> |
---|
491 | </DL> |
---|
492 | </DD> |
---|
493 | </DL> |
---|
494 | <HR> |
---|
495 | |
---|
496 | <A NAME="andNot(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
497 | andNot</H3> |
---|
498 | <PRE> |
---|
499 | <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> other)</PRE> |
---|
500 | <DL> |
---|
501 | <DD>Returns the documents in this set that are not in the other set. Neither set is modified - a new DocSet is |
---|
502 | created and returned. |
---|
503 | <P> |
---|
504 | <DD><DL> |
---|
505 | |
---|
506 | <DT><B>Returns:</B><DD>a DocSet representing this AND NOT other</DL> |
---|
507 | </DD> |
---|
508 | </DL> |
---|
509 | <HR> |
---|
510 | |
---|
511 | <A NAME="andNotSize(org.apache.solr.search.DocSet)"><!-- --></A><H3> |
---|
512 | andNotSize</H3> |
---|
513 | <PRE> |
---|
514 | int <B>andNotSize</B>(<A HREF="../../../../org/apache/solr/search/DocSet.html" title="interface in org.apache.solr.search">DocSet</A> other)</PRE> |
---|
515 | <DL> |
---|
516 | <DD>Returns the number of documents in this set that are not in the other set. |
---|
517 | <P> |
---|
518 | <DD><DL> |
---|
519 | </DL> |
---|
520 | </DD> |
---|
521 | </DL> |
---|
522 | <HR> |
---|
523 | |
---|
524 | <A NAME="getTopFilter()"><!-- --></A><H3> |
---|
525 | getTopFilter</H3> |
---|
526 | <PRE> |
---|
527 | <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> |
---|
528 | <DL> |
---|
529 | <DD>Returns a Filter for use in Lucene search methods, assuming this DocSet |
---|
530 | was generated from the top-level MultiReader that the Lucene search |
---|
531 | methods will be invoked with. |
---|
532 | <P> |
---|
533 | <DD><DL> |
---|
534 | </DL> |
---|
535 | </DD> |
---|
536 | </DL> |
---|
537 | <HR> |
---|
538 | |
---|
539 | <A NAME="setBitsOn(org.apache.lucene.util.OpenBitSet)"><!-- --></A><H3> |
---|
540 | setBitsOn</H3> |
---|
541 | <PRE> |
---|
542 | 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> target)</PRE> |
---|
543 | <DL> |
---|
544 | <DD>Takes the docs from this set and sets those bits on the target OpenBitSet. |
---|
545 | The target should be sized large enough to accommodate all of the documents before calling this method. |
---|
546 | <P> |
---|
547 | <DD><DL> |
---|
548 | </DL> |
---|
549 | </DD> |
---|
550 | </DL> |
---|
551 | <!-- ========= END OF CLASS DATA ========= --> |
---|
552 | <HR> |
---|
553 | |
---|
554 | |
---|
555 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
556 | <A NAME="navbar_bottom"><!-- --></A> |
---|
557 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
558 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
559 | <TR> |
---|
560 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
561 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
562 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
563 | <TR ALIGN="center" VALIGN="top"> |
---|
564 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
565 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
566 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
567 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DocSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
568 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
569 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
570 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
571 | </TR> |
---|
572 | </TABLE> |
---|
573 | </TD> |
---|
574 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
575 | </EM> |
---|
576 | </TD> |
---|
577 | </TR> |
---|
578 | |
---|
579 | <TR> |
---|
580 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
581 | <A HREF="../../../../org/apache/solr/search/DocListAndSet.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A> |
---|
582 | <A HREF="../../../../org/apache/solr/search/DocSetCollector.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD> |
---|
583 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
584 | <A HREF="../../../../index.html?org/apache/solr/search/DocSet.html" target="_top"><B>FRAMES</B></A> |
---|
585 | <A HREF="DocSet.html" target="_top"><B>NO FRAMES</B></A> |
---|
586 | <SCRIPT type="text/javascript"> |
---|
587 | <!-- |
---|
588 | if(window==top) { |
---|
589 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
590 | } |
---|
591 | //--> |
---|
592 | </SCRIPT> |
---|
593 | <NOSCRIPT> |
---|
594 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
595 | </NOSCRIPT> |
---|
596 | |
---|
597 | |
---|
598 | </FONT></TD> |
---|
599 | </TR> |
---|
600 | <TR> |
---|
601 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
602 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
603 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
604 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
605 | </TR> |
---|
606 | </TABLE> |
---|
607 | <A NAME="skip-navbar_bottom"></A> |
---|
608 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
609 | |
---|
610 | <HR> |
---|
611 | |
---|
612 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
613 | <script src='../../../../prettify.js' type='text/javascript'></script> |
---|
614 | <script type='text/javascript'> |
---|
615 | (function(){ |
---|
616 | var oldonload = window.onload; |
---|
617 | if (typeof oldonload != 'function') { |
---|
618 | window.onload = prettyPrint; |
---|
619 | } else { |
---|
620 | window.onload = function() { |
---|
621 | oldonload(); |
---|
622 | prettyPrint(); |
---|
623 | } |
---|
624 | } |
---|
625 | })(); |
---|
626 | </script> |
---|
627 | |
---|
628 | </BODY> |
---|
629 | </HTML> |
---|