svn commit: r806322 - in /lucene/java/trunk/src/java/org/apache/lucene/search/payloads: BoostingFunctionTermQuery.java BoostingNearQuery.java

[ma...@apache.org]

Author: markrmiller
Date: Thu Aug 20 19:40:15 2009
New Revision: 806322

URL: http://svn.apache.org/viewvc?rev=806322&view=rev
Log:
update/fix javadoc

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingFunctionTermQuery.java
    lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingFunctionTermQuery.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingFunctionTermQuery.java?rev=806322&r1=806321&r2=806322&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingFunctionTermQuery.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingFunctionTermQuery.java Thu Aug 20 19:40:15 2009
@@ -32,11 +32,16 @@
 
 import java.io.IOException;
 
-
 /**
- * The score returned is based on the maximum payload score seen for the Term on the document, as opposed
- * to the average as implemented by {@link org.apache.lucene.search.payloads.BoostingTermQuery}.
- *
+ * This class is very similar to {@link org.apache.lucene.search.spans.SpanTermQuery} 
+ * except that it factors in the value of the payload located at each of the positions
+ *  where the {@link org.apache.lucene.index.Term} occurs.
+ * <p>
+ * In order to take advantage of this, you must override
+ * {@link org.apache.lucene.search.Similarity#scorePayload(String, byte[],int,int)}
+ * which returns 1 by default.
+ * <p>
+ * Payload scores are aggregated using a pluggable {@link PayloadFunction}.
  **/
 public class BoostingFunctionTermQuery extends SpanTermQuery  implements PayloadQuery{
   protected PayloadFunction function;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java?rev=806322&r1=806321&r2=806322&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java Thu Aug 20 19:40:15 2009
@@ -35,14 +35,14 @@
 import java.util.Iterator;
 
 /**
- * The BoostingNearQuery is very similar to the {@link org.apache.lucene.search.spans.SpanNearQuery} except
+ * This class is very similar to {@link org.apache.lucene.search.spans.SpanNearQuery} except
  * that it factors in the value of the payloads located at each of the positions where the
  * {@link org.apache.lucene.search.spans.TermSpans} occurs.
  * <p/>
  * In order to take advantage of this, you must override {@link org.apache.lucene.search.Similarity#scorePayload(String, byte[],int,int)}
  * which returns 1 by default.
  * <p/>
- * Payload scores are averaged across term occurrences in the document.
+ * Payload scores are aggregated using a pluggable {@link PayloadFunction}.
  *
  * @see org.apache.lucene.search.Similarity#scorePayload(String, byte[], int, int)
  */