SpanTermQuery

extends SpanQuery

java.lang.Object
↳	org.apache.lucene.search.Query
	↳	org.apache.lucene.search.spans.SpanQuery
		↳	org.apache.lucene.search.spans.SpanTermQuery

Known Direct Subclasses

PayloadTermQuery

Class Overview

Matches spans containing a term.

Summary

Fields
protected Term	term

Public Constructors
	SpanTermQuery(Term term) Construct a SpanTermQuery matching the named term's spans.

Public Methods
boolean	equals(Object obj)
void	extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
String	getField() Returns the name of the field matched by this query.
Spans	getSpans(IndexReader reader) Expert: Returns the matches for this query in an index.
Term	getTerm() Return the term whose spans are matched.
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.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 Term term

Public Constructors

public SpanTermQuery (Term term)

Construct a SpanTermQuery matching the named term's spans.

Public Methods

public boolean equals (Object obj)

public void extractTerms (Set<Term> terms)

Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.

public String getField ()

Returns the name of the field matched by this query.

public Spans getSpans (IndexReader reader)

Expert: Returns the matches for this query in an index. Used internally to search for spans.

Throws

IOException

public Term getTerm ()

Return the term whose spans are matched.

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