Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » search » payloads » [javadoc | source]
public class: PayloadTermQuery [javadoc | source]

All Implemented Interfaces:
    Cloneable, Serializable

This class is very similar to except that it factors in the value of the payload located at each of the positions where the org.apache.lucene.index.Term occurs.

In order to take advantage of this, you must override, String, int, int, byte[],int,int) which returns 1 by default.

Payload scores are aggregated using a pluggable PayloadFunction .
Nested Class Summary:
protected class  PayloadTermQuery.PayloadTermWeight   
Field Summary
protected  PayloadFunction function     
Fields inherited from
 public PayloadTermQuery(Term term,
    PayloadFunction function) 
 public PayloadTermQuery(Term term,
    PayloadFunction function,
    boolean includeSpanScore) 
Method from Summary:
createWeight,   equals,   hashCode
Methods from
equals,   extractTerms,   getField,   getSpans,   getTerm,   hashCode,   toString
Methods from
createWeight,   getField,   getSpans
Methods from
clone,   combine,   createWeight,   equals,   extractTerms,   getBoost,   getSimilarity,   hashCode,   mergeBooleanQueries,   rewrite,   setBoost,   toString,   toString,   weight
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from Detail:
 public Weight createWeight(Searcher searcher) throws IOException 
 public boolean equals(Object obj) 
 public int hashCode()