Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update/fix javadoc 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@806322 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mark Robert Miller 2009-08-20 19:40:15 +00:00
parent c7aaef6ff0
commit c49c47515f
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/java/org/apache/lucene/search/payloads/BoostingFunctionTermQuery.java
View File

@ -32,11 +32,16 @@ import org.apache.lucene.search.spans.SpanScorer;
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;

4
src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java
View File

@ -35,14 +35,14 @@ import java.util.Collection;
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)
*/