Index: docs/demo2.pdf
===================================================================
--- docs/demo2.pdf (revision 659311)
+++ docs/demo2.pdf (working copy)
@@ -95,10 +95,10 @@
>>
endobj
20 0 obj
-<< /Length 2152 /Filter [ /ASCII85Decode /FlateDecode ]
+<< /Length 2312 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
-Gatm=hf%7-&:X@\Tsl:4.n^TLCC^U&F_NdV6b=0`L1Ln&`7Sm;d3YV7hI"$mAB@>E;Z&3_Yt[e[hL0VBh4=C[[J4=@pp'=Z%K(WVUn6m4;&$ho%F+@nIRrBiEG)u[Z?Wi^/8mnr2j[PU$a5]`i1KJFP%!E@*d(LFkO7_1QB`*K,qE,=6`m@?=/QG:Hn%oBJUYLX859lseS0;jokC,/Z7^1)k'XC+UZM&)mG[7c%Oc>GR+P#h1?[!PAZ"q"mr*O2n4]44d.N12REW3g3e"IOqQs-_X-FH]Hk\P,>gdK\:mY<2,_ACAh7bk=esTuCKq"Q/Lj4<[*W?D/N&Mj!S_PX)n_%!*&5(0<7*4]\&3\a\$$M3NM:I6:9Xi&po6=Nbos3;V15fjSBg'TIjg#*UK8J_oU]qJs-LG+@A0UoqCOcne8(NWmqrs<8u9X/$9gc7QkWefXa/68k9hqkS#TVqp'JOL2#iu]p4j(Gh*5T9'l=@p_>Q"*k&bW3S%P=XN[aGUOFhG#=m08aGGVe@Zeu+."MYXgp!S,9M=@kXuDS6WrH7.+f%bf,&,A&-*k*ib2OKL;(]SA4L_aZrVfj`b4:n=6-'GH^>+,gDGb_Sg^C4XC$\)i>(CJU.bk&I"lk.p+&:=@5):Jm3PQKJ5H]J81rfb+Fm2^V/""m$koe"A'QUd_'#YW&JHJClMs:aDcfj&n_@'d`sFu_9,^/MN[-GUI<[S`@A!nB43gg6[8OmrT#N6a/MRE\9;8@dJXWe4VV'J8O@.eQn3Wo.)]H-f=tR!gUFZP5-aR6BR98!Eg\9]ch.T-8)knVdj.$h*4UC/c([%6]q^*lbKM(ag.8J/BPHN3IUmTH@c9MhEtMFGrF@WObuMtY>1*Al%ifkK["Xg[k]SFMB9XS.V3%'ZU\[MA/TPZiuf0oB?=T,lft?1pm.'\i#Jg!*W-Q`D>gN6Y5!Z$[0s&j^jTh#fk7V2,GjkY,S*0nu,BDQ[_;SX?07p]>/i+;`']isr'<*iO>*elK,Io1[F@a/A(mh5%d]!82pl9&QSG+NgL3[",lr4`.cH7K@:9RIjr0Vs.$RFirpX(.:GaorG>Oa':RE@uH.oJnn@]2$XPZ?5.eVB$QKWp\XnLj-r:m4&<`sgm,_^J?AY"]NU_X.AUiD&=K3sn6S,4+5H;:d_,Ea9%Fr^2P[mpd//D8/n1B_c%Q+6a9VjnlL?MK1BIWM*bd29VipX%?_>Y8XueXa">CD*!U8*bM2kgrEKCm76T=Tbc>[&Bhn46`qk#j)9@(Od5ChTG4hdt1?I>5O+EPsj+unKW9[4sUFi+k``>/d8GHML,Qn+(Bo)am_[f*nNC!m4EhE-o<^4e+6&EjpU!5POd,'u55HTb)7AnZj$JGZ8Zru;.L[+-F)XWeo=i6o\^W&Bn[I6rH7<>n,CCZd%fXrs)JGTjPq@Um~>
+Gatm=>B?8n'RnB3i%<&EK0b;t+$.k/S$kE7STa%acH^#DA<:Z9(qC9tao;-"J:SpR`"+r#-5P`7kPCb<..H<[c([mY+M`]g:X%1A+Ki:W)nB\K\8O'E]LK_llp%MH1o0S;aK&nP1rg,.Kcmi1GB9-jPeRlYk/D9S_<[KrlbtD7(LMQe@qSue=3nW*VD;&n*=iqg1hcsAEUt5'N?)hAW*&eQA`AbF%<:97u87A`)Kq$.=\poM12s\\F,%K'4FL\gDpVK1?E\/r,O<0^J[0CPnoF.e8^/oUtoWgk"-^AEebFBIJ2I"'?(HLSo@a\i2Asl_9j2Q7ntOVp!pEZgrT1_Q0oati0A?'o4#uq:2#E[A0J53S/$)gTtY:IOh&:Ga#5Pl@bYUNjQ\i%5T@P,44pYFp&fB"1JT:dJ.1OYe;'/r-r-j/X%$S5;Me=bYIL_m)3&l@_T''kV1b(!MB7#.RGXNHW?;"\e6,r<6"Gt>/][Q;B9ji`,24!X,1SmmQcRXd7%(DpWXqai0kK:(KWGq#7@kFPoUimb\hN-?E>%gNYKm_dj0p0!+nlE2>oMFJ.5fhlHlD[Vo+pS'1n95->TRu+S>/F6QcK?B1>.\WgscgOPg&?KOISZXlQCjFM@:SP"pCa7?m)p0$\m>Vc#GELrj%jJ=nmOoR&C2U(RR'^=8IMb>D23I-XC+.fkL5:!^k50gRe*M!prDK7TBEF$U,F#!-5k9YU)_*2SjH.q:kB6g-#hj7AO(\*V'knQ=l=uf.]_@J8LIQTJZ[X(W;39"7rdU7(Om[cr(\o8;O:?Z#mEI\rgV1L?,BqDas9TmV-N#l-I)U=?N?UHh8kW^10[8?k2,d_PS3^tA!hajou!VY$rs$&geA5]Wk*rN(0!5ZhMia8Q=,WXDfR"V/Fa9(nn3";hYW1"r!CMoJIZ%f!8-VhUUn88/b2"hrr`qc4`]0V`]KQ>2@/C$cG42!^3X"+M"o>2!r35Z=2PSc+Sp@Rlc+LGd4AcTQLNTpC+brVFB;,LG&]&;tBEdoU'Zf2Qe-dj5iN-k,gh\_$?%b+JCmb*>1e<%(;`k/8pi#Dh!j%NZmK:"f,#m=X\pe\a>*inV;riZ>%a7MoQ0,$1TSNT3#&>jH&1fjBMW;DRX:5<320Yj&%5o!4H[-GH*:DN*+-VF=rV\HSjC4LbV3I(W\NSpb,%O.0UZA@^A30a3onMRh9f^45bZ5eCA`A)02`*Ao1@JC$ejTF=Q&4lcq$Bfl\n!Q"EUhlC#>\)Y95+pr4-S#tPjrNd-+D%/mA<$s3dh0qd4-g4XP/8,g?V=j[kY)C3&baKo'Z@iOk]:V9E24*@JU-;eV22=s*=C6cjNr'@#b^c#~>
endstream
endobj
21 0 obj
@@ -233,7 +233,7 @@
17 0 obj
<<
/S /GoTo
-/D [21 0 R /XYZ 85.0 335.866 null]
+/D [21 0 R /XYZ 85.0 290.266 null]
>>
endobj
22 0 obj
@@ -244,39 +244,39 @@
xref
0 34
0000000000 65535 f
-0000008534 00000 n
-0000008606 00000 n
-0000008698 00000 n
+0000008694 00000 n
+0000008766 00000 n
+0000008858 00000 n
0000000015 00000 n
0000000071 00000 n
0000000777 00000 n
0000000897 00000 n
0000000950 00000 n
-0000008832 00000 n
+0000008992 00000 n
0000001085 00000 n
-0000008895 00000 n
+0000009055 00000 n
0000001221 00000 n
-0000008961 00000 n
+0000009121 00000 n
0000001358 00000 n
-0000009027 00000 n
+0000009187 00000 n
0000001495 00000 n
-0000009091 00000 n
+0000009251 00000 n
0000001632 00000 n
0000004447 00000 n
0000004555 00000 n
-0000006800 00000 n
-0000009157 00000 n
-0000006908 00000 n
-0000007081 00000 n
-0000007316 00000 n
-0000007482 00000 n
-0000007677 00000 n
-0000007872 00000 n
-0000007985 00000 n
-0000008095 00000 n
-0000008203 00000 n
-0000008309 00000 n
-0000008425 00000 n
+0000006960 00000 n
+0000009317 00000 n
+0000007068 00000 n
+0000007241 00000 n
+0000007476 00000 n
+0000007642 00000 n
+0000007837 00000 n
+0000008032 00000 n
+0000008145 00000 n
+0000008255 00000 n
+0000008363 00000 n
+0000008469 00000 n
+0000008585 00000 n
trailer
<<
/Size 34
@@ -284,5 +284,5 @@
/Info 4 0 R
>>
startxref
-9208
+9368
%%EOF
Index: docs/scoring.html
===================================================================
--- docs/scoring.html (revision 659311)
+++ docs/scoring.html (working copy)
@@ -494,9 +494,9 @@
, beginning the scoring process.
Once inside the Searcher, a
- Hits
- object is constructed, which handles the scoring and caching of the search results.
- The Hits constructor stores references to three or four important objects:
+ HitCollector
+ is used for the scoring and sorting of the search results.
+ These important objects are involved in a search:
- The
@@ -521,12 +521,11 @@
-
Now that the Hits object has been initialized, it begins the process of identifying documents that
- match the query by calling getMoreDocs method. Assuming we are not sorting (since sorting doesn't
+
Assuming we are not sorting (since sorting doesn't
effect the raw Lucene score),
- we call on the "expert" search method of the Searcher, passing in our
+ we call one of the search method of the Searcher, passing in the
Weight
- object,
+ object created by Searcher.createWeight(Query),
Filter
and the number of results we want. This method
returns a
Index: docs/scoring.pdf
===================================================================
--- docs/scoring.pdf (revision 659311)
+++ docs/scoring.pdf (working copy)
@@ -213,10 +213,10 @@
>>
endobj
40 0 obj
-<< /Length 2130 /Filter [ /ASCII85Decode /FlateDecode ]
+<< /Length 2003 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
-Gatm=99\*g%)2U?BQ?["ZXH88eOq9n9t/Aoh<*)OJX0u=M-_@)3:+,&JA,9%(ZNSaL]PEVDP:e&68$cEVlpiMCT&%8KbWL'ED=qg*3j#7!V8FL0a*`I9Y2'qi[6-VZt/S:-#:lFGia.#?.uK/c1W9S(K]iDl6j:eBh:kg04u%=X"NK)@SGrPH@VB3fOPic@S4S?FM&9Oc/89Jj0Mo-C#[PPcVG,N;3#;X%B6?9=fO^T@m"6RF%"W2`^R6i-I,p?9!Q&!H>7,Q^1Yir=OEWk2PT[iH7L%8#L[E]QsbN]6Z7rs7YHi$XhguFjX6Q;D*FsM*M8:LslI&kZgX5bYKS'7LJ+S.nF,N2=eI)R#^^1j/N15,G_W.Lp[b@"eL1R02Hg8:s1ej\#kk'C#7&J$!/`fKDCmqM4!edWalag.)>m%YrFN:Cr(,sn5`\88aE$LU-(n@=5"NslC&s"][eVJfWK&uVdL7=n4NCfLpRnkM?Au%0s7EO:Xbo^>o_k+\@lrCV30Z2*g(m?a#g"ldn++$rJe_<12'V(&hO90C=)SWAdIWc7a[SRV/VOq`eOqtKbi=osU>A`[A8??WB/kIAPfSa*qreK`;I=4VG%1[f^Cq!d<#\4lnI=9aUqVJAK,9*#7P4At2/Z4RpP?*k1>e.(3!s#A^9-Fj7'339A=mcU#LD31*Y[ua?-&CB36;(OB'fJS*IUdAc/(XHlde7KS>7uk^&$)(.qUD^:TW#+LX&mcdR4s#]rlMPBOqj-p=UKh6PtJHLe;!OGjX3>(]hqMl_Qn3b[3S7`*3.TPRpsVu+TuE7Y#U2/doQ'>1c/^sUZSWMoHU_k%?Q,$@ofa1`Ldf-43E*j2FPa(6)gP3][WRPTql^9K2o-6e^Q;[3>IM%gk`)1aS&kRD_r08`0>F#SV+V2K>rXDN@)7/mcG#3O=.6cN)m:!:N%:\R%O(5>D[)\4f*)!kJ2URU!`fP40-g?bS[>.*Gr^'Xa?0FUA?TEYb*NAGX=j4$gASB@/8EWa5=\o./I>rXh`#OahqA9CbncVW!W43i!RB3d2N/:26R.FCn#$[83PQIWFjod:#9q:[AtCF-'BV3[JZl#TM/^^`b3am[L;1n9/cA#Pd,(X.lq(%oa9CLJ^X2dfV59H=>)-nh7m>N[(+daB+1*.ss))PC,56Mc_KmW.6ak.m:O_*)A(`E?>&[hPV9?p$\mm'g*iS21CUD2i_bZ[lih<+DkEEeTn4V05c'].LB_[Z,Ri]WNdsj]!+m\eCk\^$p*&-K&(XN/BNkAgC>C3YTus0#\>p:eTOciq':[A;LWn[C\Q+%_p_X=&i#1I@qjpdBYru[p0pd(Nm20Iff[7(qgFN0unG]=c=2U6T5Pm:"!(nF*,EX4hgQY"9j_jr,>Gc#/kLfP7;"PafjQg/EHo("F-.8^pN>6\^()(k8ct
+Gatm<968iG&AII3n.pAj5mY3X9.)A?DUZ8"2M\jKLkI$!'YsdB*VJ##,Xl\r!OCP'G\hFI!k\?sm^ES:R*T*bBA[@S>Nt$(ZeS'bQR%Fe)o^Y)dkF+N-`FMAI@@j:c^nF^*Y.fYoB"3b(]!n4Hc*][5`$S.o8WM=R@k9lZon)S#5q;0ZJ^>bX6G82,#V`dVC>`*nOTag"?d)l*`EnHa"4^qHW&>?Vj81&1%X`Q=n6oja45]6_'$H3`rOH9XR-IJrt!0^gZ$[C)`.aBsE@OAQdgr-ou+Pf>+EK+Z-8Q=%&JS>b!X-YuYCU>/Q=C`N:H3]<8C&W3t8^!aIR4\04>@PI];QQ%PW[@QBI.k9pX.hun>K@&.Pn923_jRr0hs#5NG'G`-s@Cr2l(9/_>=nB(2(&PJ8mpcuj,)jCdpE^UcHShd)$oWVV0G7MI%=EiL9s7g0X0rHf8-S`EHO"8R9#&d?P[I0.6EPg"47l%?^3-<"j'W[5X7_T\&&>&J6j]TC04kq2B#n*.q4[qO^/.k=:[e$A0?1`u-YmCAJK`k^[GT'W,hL4UXZ^,_D$kUoADPaonm$.sk_QU]%iW!NaU]=+C*6.;Jck8/lRW(@gHIp$$85jR;`fs#]tEAJ0'J`L80)ZA;BZYh]0pa-.(W)@#RmWqY8n1><#_UE)l+O]n4SB\i*+s\Wj\^H,]rM-o?N+D`UB1iNc%8G[g1?o&JY:\G?T2#EQ4#?F\.(1VPJ=]Z8l'r6I>S-*081u!eB\iHhr<=p*W_hADQq?dt_3O*d(Xf=Wa@o7dSf>i+4;t\rK@%LiAIE`h.u"_e*V?nh^[2XKhfhW?GOdVt/e-b?GF"7+b:4)XjhbHkaNT"jqA'+Mq03nd&gkcCU*qAN!@#")i/QG'DW#Z65-9E93/@mQN2qZ:MU9$d23"CrMcLBfAYUh#oI(Uql_g8_W^e+95Miq3iteh/4&L5.TaVSo;5)Lqp<)mM^ab[feJRYEAN7W
endstream
endobj
41 0 obj
@@ -484,39 +484,39 @@
xref
0 63
0000000000 65535 f
-0000017942 00000 n
-0000018035 00000 n
-0000018127 00000 n
+0000017815 00000 n
+0000017908 00000 n
+0000018000 00000 n
0000000015 00000 n
0000000071 00000 n
0000001068 00000 n
0000001188 00000 n
0000001297 00000 n
-0000018250 00000 n
+0000018123 00000 n
0000001432 00000 n
-0000018313 00000 n
+0000018186 00000 n
0000001569 00000 n
-0000018379 00000 n
+0000018252 00000 n
0000001706 00000 n
-0000018445 00000 n
+0000018318 00000 n
0000001843 00000 n
-0000018509 00000 n
+0000018382 00000 n
0000001979 00000 n
-0000018575 00000 n
+0000018448 00000 n
0000002116 00000 n
-0000018641 00000 n
+0000018514 00000 n
0000002253 00000 n
-0000018705 00000 n
+0000018578 00000 n
0000002389 00000 n
-0000018771 00000 n
+0000018644 00000 n
0000002526 00000 n
-0000018837 00000 n
+0000018710 00000 n
0000002663 00000 n
-0000018901 00000 n
+0000018774 00000 n
0000002799 00000 n
-0000018967 00000 n
+0000018840 00000 n
0000002935 00000 n
-0000019033 00000 n
+0000018906 00000 n
0000003072 00000 n
0000005698 00000 n
0000005806 00000 n
@@ -524,28 +524,28 @@
0000008243 00000 n
0000010669 00000 n
0000010777 00000 n
-0000013000 00000 n
-0000013108 00000 n
-0000014526 00000 n
-0000019098 00000 n
-0000014634 00000 n
-0000014797 00000 n
-0000014985 00000 n
-0000015205 00000 n
-0000015404 00000 n
-0000015715 00000 n
-0000015919 00000 n
-0000016112 00000 n
-0000016327 00000 n
-0000016648 00000 n
-0000016828 00000 n
-0000017013 00000 n
-0000017230 00000 n
-0000017386 00000 n
-0000017499 00000 n
-0000017609 00000 n
-0000017717 00000 n
-0000017833 00000 n
+0000012873 00000 n
+0000012981 00000 n
+0000014399 00000 n
+0000018971 00000 n
+0000014507 00000 n
+0000014670 00000 n
+0000014858 00000 n
+0000015078 00000 n
+0000015277 00000 n
+0000015588 00000 n
+0000015792 00000 n
+0000015985 00000 n
+0000016200 00000 n
+0000016521 00000 n
+0000016701 00000 n
+0000016886 00000 n
+0000017103 00000 n
+0000017259 00000 n
+0000017372 00000 n
+0000017482 00000 n
+0000017590 00000 n
+0000017706 00000 n
trailer
<<
/Size 63
@@ -553,5 +553,5 @@
/Info 4 0 R
>>
startxref
-19149
+19022
%%EOF
Index: src/demo/org/apache/lucene/demo/SearchFiles.java
===================================================================
--- src/demo/org/apache/lucene/demo/SearchFiles.java (revision 659311)
+++ src/demo/org/apache/lucene/demo/SearchFiles.java (working copy)
@@ -17,23 +17,25 @@
* limitations under the License.
*/
+import java.io.BufferedReader;
+import java.io.FileReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.Date;
+
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.FilterIndexReader;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.queryParser.QueryParser;
-import org.apache.lucene.search.Hits;
+import org.apache.lucene.search.HitCollector;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.Query;
+import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.Searcher;
+import org.apache.lucene.search.TopDocCollector;
-import java.io.BufferedReader;
-import java.io.FileReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.util.Date;
-
/** Simple command-line based search demo. */
public class SearchFiles {
@@ -60,7 +62,8 @@
/** Simple command-line based search demo. */
public static void main(String[] args) throws Exception {
String usage =
- "Usage: java org.apache.lucene.demo.SearchFiles [-index dir] [-field f] [-repeat n] [-queries file] [-raw] [-norms field]";
+ "Usage:\tjava org.apache.lucene.demo.SearchFiles [-index dir] [-field f] [-repeat n] [-queries file] [-raw] [-norms field] [-paging hitsPerPage]";
+ usage += "\n\tSpecify 'false' for hitsPerPage to use streaming instead of paging search.";
if (args.length > 0 && ("-h".equals(args[0]) || "-help".equals(args[0]))) {
System.out.println(usage);
System.exit(0);
@@ -72,6 +75,8 @@
int repeat = 0;
boolean raw = false;
String normsField = null;
+ boolean paging = true;
+ int hitsPerPage = 10;
for (int i = 0; i < args.length; i++) {
if ("-index".equals(args[i])) {
@@ -91,6 +96,16 @@
} else if ("-norms".equals(args[i])) {
normsField = args[i+1];
i++;
+ } else if ("-paging".equals(args[i])) {
+ if (args[i+1].equals("false")) {
+ paging = false;
+ } else {
+ hitsPerPage = Integer.parseInt(args[i+1]);
+ if (hitsPerPage == 0) {
+ paging = false;
+ }
+ }
+ i++;
}
}
@@ -125,53 +140,149 @@
Query query = parser.parse(line);
System.out.println("Searching for: " + query.toString(field));
- Hits hits = searcher.search(query);
-
+
if (repeat > 0) { // repeat & time as benchmark
Date start = new Date();
for (int i = 0; i < repeat; i++) {
- hits = searcher.search(query);
+ searcher.search(query, null, 100);
}
Date end = new Date();
System.out.println("Time: "+(end.getTime()-start.getTime())+"ms");
}
- System.out.println(hits.length() + " total matching documents");
+ if (paging) {
+ doPagingSearch(in, searcher, query, hitsPerPage, raw, queries == null);
+ } else {
+ doStreamingSearch(searcher, query);
+ }
+ }
+ reader.close();
+ }
+
+ /**
+ * This method uses a custom HitCollector implementation which simply prints out
+ * the docId and score of every matching document.
+ *
+ * This simulates the streaming search use case, where all hits are supposed to
+ * be processed, regardless of their relevance.
+ */
+ public static void doStreamingSearch(final Searcher searcher, Query query) throws IOException {
+ HitCollector streamingHitCollector = new HitCollector() {
+
+ // simply print docId and score of every matching document
+ public void collect(int doc, float score) {
+ System.out.println("doc="+doc+" score="+score);
+ }
+
+ };
+
+ searcher.search(query, streamingHitCollector);
+ }
- final int HITS_PER_PAGE = 10;
- for (int start = 0; start < hits.length(); start += HITS_PER_PAGE) {
- int end = Math.min(hits.length(), start + HITS_PER_PAGE);
- for (int i = start; i < end; i++) {
+ /**
+ * This demonstrates a typical paging search scenario, where the search engine presents
+ * pages of size n to the user. The user can then go to the next page if interested in
+ * the next hits.
+ *
+ * When the query is executed for the first time, then only enough results are collected
+ * to fill 5 result pages. If the user wants to page beyond this limit, then the query
+ * is executed another time and all hits are collected.
+ *
+ */
+ public static void doPagingSearch(BufferedReader in, Searcher searcher, Query query,
+ int hitsPerPage, boolean raw, boolean interactive) throws IOException {
+
+ // Collect enough docs to show 5 pages
+ TopDocCollector collector = new TopDocCollector(5 * hitsPerPage);
+ searcher.search(query, collector);
+ ScoreDoc[] hits = collector.topDocs().scoreDocs;
+
+ int numTotalHits = collector.getTotalHits();
+ System.out.println(numTotalHits + " total matching documents");
- if (raw) { // output raw format
- System.out.println("doc="+hits.id(i)+" score="+hits.score(i));
- continue;
+ int start = 0;
+ int end = Math.min(numTotalHits, hitsPerPage);
+
+ while (true) {
+ if (end > hits.length) {
+ System.out.println("Only results 1 - " + hits.length +" of " + numTotalHits + " total matching documents collected.");
+ System.out.println("Collect more (y/n) ?");
+ String line = in.readLine();
+ if (line.length() == 0 || line.charAt(0) == 'n') {
+ break;
+ }
+
+ collector = new TopDocCollector(numTotalHits);
+ searcher.search(query, collector);
+ hits = collector.topDocs().scoreDocs;
+ }
+
+ end = Math.min(hits.length, start + hitsPerPage);
+
+ for (int i = start; i < end; i++) {
+ if (raw) { // output raw format
+ System.out.println("doc="+hits[i].doc+" score="+hits[i].score);
+ continue;
+ }
+
+ Document doc = searcher.doc(hits[i].doc);
+ String path = doc.get("path");
+ if (path != null) {
+ System.out.println((i+1) + ". " + path);
+ String title = doc.get("title");
+ if (title != null) {
+ System.out.println(" Title: " + doc.get("title"));
}
+ } else {
+ System.out.println((i+1) + ". " + "No path for this document");
+ }
+
+ }
- Document doc = hits.doc(i);
- String path = doc.get("path");
- if (path != null) {
- System.out.println((i+1) + ". " + path);
- String title = doc.get("title");
- if (title != null) {
- System.out.println(" Title: " + doc.get("title"));
+ if (!interactive) {
+ break;
+ }
+
+ if (numTotalHits >= end) {
+ boolean quit = false;
+ while (true) {
+ System.out.print("Press ");
+ if (start - hitsPerPage >= 0) {
+ System.out.print("(p)revious page, ");
+ }
+ if (start + hitsPerPage < numTotalHits) {
+ System.out.print("(n)ext page, ");
+ }
+ System.out.println("(q)uit or enter number to jump to a page.");
+
+ String line = in.readLine();
+ if (line.length() == 0 || line.charAt(0)=='q') {
+ quit = true;
+ break;
+ }
+ if (line.charAt(0) == 'p') {
+ start = Math.max(0, start - hitsPerPage);
+ break;
+ } else if (line.charAt(0) == 'n') {
+ if (start + hitsPerPage < numTotalHits) {
+ start+=hitsPerPage;
}
+ break;
} else {
- System.out.println((i+1) + ". " + "No path for this document");
+ int page = Integer.parseInt(line);
+ if ((page - 1) * hitsPerPage < numTotalHits) {
+ start = (page - 1) * hitsPerPage;
+ break;
+ } else {
+ System.out.println("No such page");
+ }
}
}
-
- if (queries != null) // non-interactive
- break;
-
- if (hits.length() > end) {
- System.out.println("more (y/n) ? ");
- line = in.readLine();
- if (line.length() == 0 || line.charAt(0) == 'n')
- break;
- }
+ if (quit) break;
+ end = Math.min(numTotalHits, start + hitsPerPage);
}
+
}
- reader.close();
+
}
}
Index: src/java/org/apache/lucene/document/Document.java
===================================================================
--- src/java/org/apache/lucene/document/Document.java (revision 659311)
+++ src/java/org/apache/lucene/document/Document.java (working copy)
@@ -18,7 +18,7 @@
*/
import java.util.*; // for javadoc
-import org.apache.lucene.search.Hits; // for javadoc
+import org.apache.lucene.search.ScoreDoc; // for javadoc
import org.apache.lucene.search.Searcher; // for javadoc
import org.apache.lucene.index.IndexReader; // for javadoc
@@ -32,7 +32,7 @@
*
* Note that fields which are not {@link Fieldable#isStored() stored} are
* not available in documents retrieved from the index, e.g. with {@link
- * Hits#doc(int)}, {@link Searcher#doc(int)} or {@link
+ * ScoreDoc#doc}, {@link Searcher#doc(int)} or {@link
* IndexReader#document(int)}.
*/
Index: src/java/org/apache/lucene/search/Hit.java
===================================================================
--- src/java/org/apache/lucene/search/Hit.java (revision 659311)
+++ src/java/org/apache/lucene/search/Hit.java (working copy)
@@ -26,6 +26,7 @@
* Wrapper used by {@link HitIterator} to provide a lazily loaded hit
* from {@link Hits}.
*
+ * @deprecated Hits will be removed in Lucene 3.0. Use {@link TopDocCollector} and {@link TopDocs} instead.
* @author Jeremy Rayner
*/
public class Hit implements java.io.Serializable {
Index: src/java/org/apache/lucene/search/HitIterator.java
===================================================================
--- src/java/org/apache/lucene/search/HitIterator.java (revision 659311)
+++ src/java/org/apache/lucene/search/HitIterator.java (working copy)
@@ -25,6 +25,7 @@
* {@link Hits#iterator()} returns an instance of this class. Calls to {@link #next()}
* return a {@link Hit} instance.
*
+ * @deprecated Hits will be removed in Lucene 3.0. Use {@link TopDocCollector} and {@link TopDocs} instead.
* @author Jeremy Rayner
*/
public class HitIterator implements Iterator {
@@ -76,3 +77,4 @@
}
}
+
Index: src/java/org/apache/lucene/search/Hits.java
===================================================================
--- src/java/org/apache/lucene/search/Hits.java (revision 659311)
+++ src/java/org/apache/lucene/search/Hits.java (working copy)
@@ -38,6 +38,19 @@
* {@link java.util.ConcurrentModificationException ConcurrentModificationException}
* is thrown when accessing hit n ≥ current_{@link #length()}
* (but n < {@link #length()}_at_start).
+ *
+ * @deprecated Hits will be removed in Lucene 3.0.
+ * Instead e. g. {@link TopDocCollector} and {@link TopDocs} can be used:
+ *
+ * TopDocCollector collector = new TopDocCollector(hitsPerPage);
+ * searcher.search(query, collector);
+ * ScoreDoc[] hits = collector.topDocs().scoreDocs;
+ * for (int i = 0; i < hits.length; i++) {
+ * int docId = hits[i].doc;
+ * Document d = searcher.doc(docId);
+ * // do something with current hit
+ * ...
+ *
*/
public final class Hits {
private Weight weight;
Index: src/java/org/apache/lucene/search/Searcher.java
===================================================================
--- src/java/org/apache/lucene/search/Searcher.java (revision 659311)
+++ src/java/org/apache/lucene/search/Searcher.java (working copy)
@@ -33,6 +33,8 @@
/** Returns the documents matching query.
* @throws BooleanQuery.TooManyClauses
+ * @deprecated Hits will be removed in Lucene 3.0. Use
+ * {@link #search(Query, Filter, int))} instead.
*/
public final Hits search(Query query) throws IOException {
return search(query, (Filter)null);
@@ -41,6 +43,8 @@
/** Returns the documents matching query and
* filter.
* @throws BooleanQuery.TooManyClauses
+ * @deprecated Hits will be removed in Lucene 3.0. Use
+ * {@link #search(Query, Filter, int))} instead.
*/
public Hits search(Query query, Filter filter) throws IOException {
return new Hits(this, query, filter);
@@ -49,6 +53,8 @@
/** Returns documents matching query sorted by
* sort.
* @throws BooleanQuery.TooManyClauses
+ * @deprecated Hits will be removed in Lucene 3.0. Use
+ * {@link #search(Query, Filter, int, Sort))} instead.
*/
public Hits search(Query query, Sort sort)
throws IOException {
@@ -58,13 +64,15 @@
/** Returns documents matching query and filter,
* sorted by sort.
* @throws BooleanQuery.TooManyClauses
+ * @deprecated Hits will be removed in Lucene 3.0. Use
+ * {@link #search(Query, Filter, int, Sort))} instead.
*/
public Hits search(Query query, Filter filter, Sort sort)
throws IOException {
return new Hits(this, query, filter, sort);
}
- /** Expert: Low-level search implementation with arbitrary sorting. Finds
+ /** Search implementation with arbitrary sorting. Finds
* the top n hits for query, applying
* filter if non-null, and sorting the hits by the criteria in
* sort.
@@ -105,7 +113,7 @@
*
* Applications should only use this if they need all of the
* matching documents. The high-level search API ({@link
- * Searcher#search(Query)}) is usually more efficient, as it skips
+ * Searcher#search(Query, Filter, int))}) is usually more efficient, as it skips
* non-high-scoring hits.
*
* @param query to match documents
@@ -118,13 +126,9 @@
search(createWeight(query), filter, results);
}
- /** Expert: Low-level search implementation. Finds the top n
+ /** Finds the top n
* hits for query, applying filter if non-null.
*
- *
Called by {@link Hits}.
- *
- *
Applications should usually call {@link Searcher#search(Query)} or
- * {@link Searcher#search(Query,Filter)} instead.
* @throws BooleanQuery.TooManyClauses
*/
public TopDocs search(Query query, Filter filter, int n)
Index: src/site/src/documentation/content/xdocs/demo2.xml
===================================================================
--- src/site/src/documentation/content/xdocs/demo2.xml (revision 659311)
+++ src/site/src/documentation/content/xdocs/demo2.xml (working copy)
@@ -118,10 +118,14 @@
href="api/org/apache/lucene/search/Query.html">Query object without using the query
parser. The query parser just enables decoding the Lucene query
syntax into the corresponding Query object. The searcher results are
-returned in a collection of Documents called Hits which is then iterated through and
-displayed to the user.
+href="api/org/apache/lucene/search/Query.html">Query object. Search can be executed in
+two different ways:
+
+- Streaming: A
HitCollector subclass
+simply prints out the document ID and score for each matching document.
+- Paging: Using a
TopDocCollector
+the search results are printed in pages, sorted by score (i. e. relevance).
+
@@ -137,3 +141,4 @@