org.apache.lucene.search.spans

Class SpanQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

FieldMaskingSpanQuery, SpanBoostQuery, SpanContainingQuery, SpanMultiTermQueryWrapper, SpanNearQuery, SpanNotQuery, SpanOrQuery, SpanPositionCheckQuery, SpanTermQuery, SpanWithinQuery

public abstract class SpanQuery
extends Query

Base class for span-based queries.

Constructor Summary

Constructors

Constructor and Description
SpanQuery()

Method Summary

Methods

Modifier and Type	Method and Description
abstract SpanWeight	createWeight(IndexSearcher searcher, boolean needsScores) Create a SpanWeight for this query
abstract String	getField() Returns the name of the field matched by this query.
static Map<Term,TermContext>	getTermContexts(Collection<SpanWeight> weights) Build a map of terms to termcontexts, for use in constructing SpanWeights
static Map<Term,TermContext>	getTermContexts(SpanWeight... weights) Build a map of terms to termcontexts, for use in constructing SpanWeights
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.

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

clone, equals, getBoost, hashCode, setBoost, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpanQuery

public SpanQuery()

Method Detail

getField

public abstract String getField()

Returns the name of the field matched by this query.

createWeight

public abstract SpanWeight createWeight(IndexSearcher searcher,
                      boolean needsScores)
                                 throws IOException

Create a SpanWeight for this query

Overrides:

createWeight in class Query

Parameters:

searcher - the IndexSearcher to be searched across

needsScores - if the query needs scores

Returns:

a SpanWeight

Throws:

IOException - on error

getTermContexts

public static Map<Term,TermContext> getTermContexts(SpanWeight... weights)

Build a map of terms to termcontexts, for use in constructing SpanWeights

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

getTermContexts

public static Map<Term,TermContext> getTermContexts(Collection<SpanWeight> weights)

Build a map of terms to termcontexts, for use in constructing SpanWeights

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

rewrite

public Query rewrite(IndexReader reader)
              throws IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Overrides:

rewrite in class Query

Throws:

IOException