diff --git a/src/java/org/apache/lucene/search/HitCollector.java b/src/java/org/apache/lucene/search/HitCollector.java index de22ddbca16..c4e1d753107 100644 --- a/src/java/org/apache/lucene/search/HitCollector.java +++ b/src/java/org/apache/lucene/search/HitCollector.java @@ -56,6 +56,7 @@ package org.apache.lucene.search; /** Lower-level search API. * @see Searcher#search(Query,HitCollector) + * @version $Id$ */ public abstract class HitCollector { /** Called once for every non-zero scoring document, with the document number @@ -77,6 +78,10 @@ public abstract class HitCollector { * Searcher#doc(int)} or {@link * org.apache.lucene.index.IndexReader#document(int)} on every document * number encountered. Doing so can slow searches by an order of magnitude - * or more. */ + * or more. + *
Note: The score
passed to this method is a raw score.
+ * In other words, the score will not necessarily be a float whose value is
+ * between 0 and 1.
+ */
public abstract void collect(int doc, float score);
}
diff --git a/src/java/org/apache/lucene/search/Searcher.java b/src/java/org/apache/lucene/search/Searcher.java
index 63c5a3333e2..7ff832fe060 100644
--- a/src/java/org/apache/lucene/search/Searcher.java
+++ b/src/java/org/apache/lucene/search/Searcher.java
@@ -79,7 +79,11 @@ public abstract class Searcher implements Searchable {
*
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 - * non-high-scoring hits. */ + * non-high-scoring hits. + *
Note: The score
passed to this method is a raw score.
+ * In other words, the score will not necessarily be a float whose value is
+ * between 0 and 1.
+ */
public void search(Query query, HitCollector results)
throws IOException {
search(query, (Filter)null, results);