lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From markrmil...@apache.org
Subject svn commit: r806893 - /lucene/java/trunk/src/java/org/apache/lucene/search/package.html
Date Sat, 22 Aug 2009 21:17:01 GMT
Author: markrmiller
Date: Sat Aug 22 21:16:59 2009
New Revision: 806893

URL: http://svn.apache.org/viewvc?rev=806893&view=rev
Log:
more work on Scorer javadoc in package.html

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/package.html

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/package.html
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/package.html?rev=806893&r1=806892&r2=806893&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/package.html (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/package.html Sat Aug 22 21:16:59 2009
@@ -345,7 +345,8 @@
     <p>The
         <a href="Scorer.html">Scorer</a>
         abstract class provides common scoring functionality for all Scorer implementations
and
-        is the heart of the Lucene scoring process. The Scorer defines the following abstract
methods which
+        is the heart of the Lucene scoring process. The Scorer defines the following abstract
(they are not
+        yet abstract, but will be in Lucene 3.0 and should be considered as such now) methods
which
         must be implemented (some of them inherited from <a href="DocIdSetIterator.html">DocIdSetIterator</a>
):
         <ol>
             <li>
@@ -358,7 +359,11 @@
                 that contains the match. It is not valid until next() has been called at
least once.
             </li>
             <li>
-                <a href="Scorer.html#score(org.apache.lucene.search.Collector, int, int)">Scorer#score(Collector,
int, int)</a> &mdash; Return the score of the
+                <a href="Scorer.html#score(org.apache.lucene.search.Collector)">Scorer#score(Collector)</a>
&mdash;
+                Scores and collects all matching documents using the given Collector.
+            </li>
+            <li>
+                <a href="Scorer.html#score()">Scorer#score()</a> &mdash;
Return the score of the
                 current document. This value can be determined in any
                 appropriate way for an application. For instance, the
                 <a href="http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/TermScorer.java?view=log">TermScorer</a>
@@ -367,7 +372,7 @@
             <li>
                 <a href="DocIdSetIterator.html#advance(int)">DocIdSetIterator#advance(int)</a>
&mdash; Skip ahead in
                 the document matches to the document whose id is greater than
-                or equal to the passed in value. In many instances, skipTo can be
+                or equal to the passed in value. In many instances, advance can be
                 implemented more efficiently than simply looping through all the matching
documents until
                 the target document is identified.</li>
         </ol>
@@ -379,8 +384,6 @@
         task that you want to do. You might be doing some cutting edge research or you need
more information
         back
         out of Lucene (similar to Doug adding SpanQuery functionality).</p>
-<h4>Examples</h4>
-    <p >FILL IN HERE</p>
 
 </body>
 </html>



Mime
View raw message