public class

PayloadNearQuery

extends SpanNearQuery

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

Class Overview

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 scorePayload(int, String, int, int, byte[], int, int) which returns 1 by default.

Payload scores are aggregated using a pluggable PayloadFunction.

Summary

Nested Classes
class	PayloadNearQuery.PayloadNearSpanScorer
class	PayloadNearQuery.PayloadNearSpanWeight

Fields
protected String	fieldName
protected PayloadFunction	function

[Expand]

Inherited Fields

From class org.apache.lucene.search.spans.SpanNearQuery

Public Constructors
	PayloadNearQuery(SpanQuery[] clauses, int slop, boolean inOrder)
	PayloadNearQuery(SpanQuery[] clauses, int slop, boolean inOrder, PayloadFunction function)

Public Methods
Object	clone() Returns a clone of this query.
Weight	createWeight(Searcher searcher) Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object obj) Returns true iff `o` is equal to this.
int	hashCode()
String	toString(String field) Prints a query to a string, with `field` assumed to be the default field and omitted.

[Expand]

Inherited Methods

From class org.apache.lucene.search.spans.SpanNearQuery

Object	clone() Returns a clone of this query.
boolean	equals(Object o) Returns true iff `o` is equal to this.
void	extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
SpanQuery[]	getClauses() Return the clauses whose spans are matched.
String	getField() Returns the name of the field matched by this query.
int	getSlop() Return the maximum number of intervening unmatched positions permitted.
Spans	getSpans(IndexReader reader) Expert: Returns the matches for this query in an index.
int	hashCode()
boolean	isInOrder() Return true if matches are required to be in-order.
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
String	toString(String field) Prints a query to a string, with `field` assumed to be the default field and omitted.

From class org.apache.lucene.search.spans.SpanQuery

From class org.apache.lucene.search.Query

Object	clone() Returns a clone of this query.
Query	combine(Query[] queries) Expert: called when re-writing queries under MultiSearcher.
Weight	createWeight(Searcher searcher) Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object obj)
void	extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
float	getBoost() Gets the boost for this clause.
Similarity	getSimilarity(Searcher searcher) Expert: Returns the Similarity implementation to be used for this query.
int	hashCode()
static Query	mergeBooleanQueries(BooleanQuery... queries) Expert: merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
void	setBoost(float b) Sets the boost for this query clause to `b`.
String	toString() Prints a query to a string.
abstract String	toString(String field) Prints a query to a string, with `field` assumed to be the default field and omitted.
Weight	weight(Searcher searcher) Expert: Constructs and initializes a Weight for a top-level query.

From class java.lang.Object

Fields

protected String fieldName

protected PayloadFunction function

Public Constructors

public PayloadNearQuery (SpanQuery[] clauses, int slop, boolean inOrder)

public PayloadNearQuery (SpanQuery[] clauses, int slop, boolean inOrder, PayloadFunction function)

Public Methods

public Object clone ()

Returns a clone of this query.

public Weight createWeight (Searcher searcher)

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Throws

IOException

public boolean equals (Object obj)

Returns true iff o is equal to this.

public int hashCode ()

public String toString (String field)

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.

Classes