PayloadTermQuery (Lucene 3.6.2 API)

java.lang.Object
- org.apache.lucene.search.Query
- - org.apache.lucene.search.spans.SpanQuery
  - - org.apache.lucene.search.spans.SpanTermQuery
    - - org.apache.lucene.search.payloads.PayloadTermQuery

All Implemented Interfaces:

Serializable, Cloneable
```
public class PayloadTermQuery
extends SpanTermQuery
```
This class is very similar to SpanTermQuery except that it factors in the value of the payload located at each of the positions where the Term occurs.
In order to take advantage of this, you must override Similarity.scorePayload(int, String, int, int, byte[],int,int) which returns 1 by default.
Payload scores are aggregated using a pluggable PayloadFunction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected class PayloadTermQuery.PayloadTermWeight

Field Summary

Fields
Modifier and Type Field Description

protected PayloadFunction function
- Fields inherited from class org.apache.lucene.search.spans.SpanTermQuery
  term

Constructor Summary

Constructors
Constructor	Description
`PayloadTermQuery(Term term, PayloadFunction function)`
`PayloadTermQuery(Term term, PayloadFunction function, boolean includeSpanScore)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Weight`	`createWeight(Searcher searcher)`	Expert: Constructs an appropriate Weight implementation for this query.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`

Methods inherited from class org.apache.lucene.search.spans.SpanTermQuery
extractTerms, getField, getSpans, getTerm, toString

Methods inherited from class org.apache.lucene.search.Query
clone, combine, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, weight

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- function
```
protected PayloadFunction function
```

Constructor Detail

PayloadTermQuery

public PayloadTermQuery(Term term,
                        PayloadFunction function)

PayloadTermQuery

public PayloadTermQuery(Term term,
                        PayloadFunction function,
                        boolean includeSpanScore)

Method Detail
- createWeight
```
public Weight createWeight(Searcher searcher)
                    throws IOException
```
  Description copied from class: Query
  
  Expert: Constructs an appropriate Weight implementation for this query.
  Only implemented by primitive queries, which re-write to themselves.
  
  Overrides:
  
  createWeight in class SpanQuery
  
  Throws:
  
  IOException
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class SpanTermQuery
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class SpanTermQuery