org.apache.lucene.search.payloads
Class PayloadNearQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.spans.SpanQuery
org.apache.lucene.search.spans.SpanNearQuery
org.apache.lucene.search.payloads.PayloadNearQuery
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
public class PayloadNearQuery
- extends SpanNearQuery
This class is very similar to
SpanNearQuery
except that it factors
in the value of the payloads located at each of the positions where the
TermSpans
occurs.
In order to take advantage of this, you must override
Similarity.scorePayload(String, byte[],int,int)
which returns 1 by default.
Payload scores are aggregated using a pluggable PayloadFunction
.
- See Also:
Similarity.scorePayload(String, byte[], int,
int)
,
Serialized Form
Method Summary |
java.lang.Object |
clone()
Returns a clone of this query. |
Weight |
createWeight(Searcher searcher)
Expert: Constructs an appropriate Weight implementation for this query. |
boolean |
equals(java.lang.Object obj)
Returns true iff o is equal to this. |
int |
hashCode()
|
java.lang.String |
toString(java.lang.String field)
Prints a query to a string, with field assumed to be the
default field and omitted. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
fieldName
protected java.lang.String fieldName
function
protected PayloadFunction function
PayloadNearQuery
public PayloadNearQuery(SpanQuery[] clauses,
int slop,
boolean inOrder)
PayloadNearQuery
public PayloadNearQuery(SpanQuery[] clauses,
int slop,
boolean inOrder,
PayloadFunction function)
createWeight
public Weight createWeight(Searcher searcher)
throws java.io.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:
java.io.IOException
clone
public java.lang.Object clone()
- Description copied from class:
Query
- Returns a clone of this query.
- Overrides:
clone
in class SpanNearQuery
toString
public java.lang.String toString(java.lang.String field)
- Description copied from class:
Query
- Prints a query to a string, with
field
assumed to be the
default field and omitted.
The representation used is one that is supposed to be readable
by QueryParser
. However,
there are the following limitations:
- If the query was created by the parser, the printed
representation may not be exactly what was parsed. For example,
characters that need to be escaped will be represented without
the required backslash.
- Some of the more complicated queries (e.g. span queries)
don't have a representation that can be parsed by QueryParser.
- Overrides:
toString
in class SpanNearQuery
hashCode
public int hashCode()
- Overrides:
hashCode
in class SpanNearQuery
equals
public boolean equals(java.lang.Object obj)
- Description copied from class:
SpanNearQuery
- Returns true iff
o
is equal to this.
- Overrides:
equals
in class SpanNearQuery
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.