org.apache.lucene.search.spans

Class SpanQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

FieldMaskingSpanQuery, SpanMultiTermQueryWrapper, SpanNearQuery, SpanNotQuery, SpanOrQuery, SpanPositionCheckQuery, SpanTermQuery

public abstract class SpanQuery
extends Query

Base class for span-based queries.

Constructor Summary

Constructors

Constructor and Description
SpanQuery()

Method Summary

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher) Expert: Constructs an appropriate Weight implementation for this query.
abstract java.lang.String	getField() Returns the name of the field matched by this query.
abstract Spans	getSpans(AtomicReaderContext context, Bits acceptDocs, java.util.Map<Term,TermContext> termContexts) Expert: Returns the matches for this query in an index.

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

clone, equals, extractTerms, getBoost, hashCode, rewrite, setBoost, toString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpanQuery

public SpanQuery()

Method Detail

getSpans

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

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

Throws:

java.io.IOException

getField

public abstract java.lang.String getField()

Returns the name of the field matched by this query.

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

createWeight

public Weight createWeight(IndexSearcher 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 Query

Throws:

java.io.IOException