Package org.apache.lucene.search.spans

Class SpanTermQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.spans.SpanTermQuery

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

PayloadTermQuery

public class SpanTermQuery
extends SpanQuery

Matches spans containing a term.

Constructor Summary

Constructors

Constructor	Description
SpanTermQuery(Term term)	Construct a SpanTermQuery matching the named term's spans.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
void	extractTerms(java.util.Set<Term> terms)	Expert: adds all terms occurring in this query to the terms set.
java.lang.String	getField()	Returns the name of the field matched by this query.
Spans	getSpans(AtomicReaderContext context, Bits acceptDocs, java.util.Map<Term,TermContext> termContexts)	Expert: Returns the matches for this query in an index.
Term	getTerm()	Return the term whose spans are matched.
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 org.apache.lucene.search.spans.SpanQuery

createWeight

Methods inherited from class org.apache.lucene.search.Query

clone, getBoost, rewrite, setBoost, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpanTermQuery

public SpanTermQuery(Term term)

Construct a SpanTermQuery matching the named term's spans.

Method Detail

getTerm

public Term getTerm()

Return the term whose spans are matched.

getField

public java.lang.String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Note that this may return null if the query matches no terms.

Specified by:

getField in class SpanQuery

extractTerms

public void extractTerms(java.util.Set<Term> terms)

Description copied from class: Query

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

Overrides:

extractTerms in class Query

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.

Specified by:

toString in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Query

getSpans

public Spans getSpans(AtomicReaderContext context,
                      Bits acceptDocs,
                      java.util.Map<Term,TermContext> termContexts)
               throws java.io.IOException

Description copied from class: SpanQuery

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

Specified by:

getSpans in class SpanQuery

Throws:

java.io.IOException