org.apache.lucene.spatial.prefix

Class AbstractPrefixTreeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.spatial.prefix.AbstractPrefixTreeQuery

Direct Known Subclasses:

AbstractVisitingPrefixTreeQuery, ContainsPrefixTreeQuery

public abstract class AbstractPrefixTreeQuery
extends Query

Base class for Lucene Queries on SpatialPrefixTree fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractPrefixTreeQuery.BaseTermsEnumTraverser Holds transient state and docid collecting utility methods as part of traversing a TermsEnum for a LeafReaderContext.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	detailLevel
protected String	fieldName
protected SpatialPrefixTree	grid
protected com.spatial4j.core.shape.Shape	queryShape

Constructor Summary

Constructors

Constructor and Description
AbstractPrefixTreeQuery(com.spatial4j.core.shape.Shape queryShape, String fieldName, SpatialPrefixTree grid, int detailLevel)

Method Summary

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher, boolean needsScores) Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object o) Override and implement query instance equivalence properly in a subclass.
protected abstract DocIdSet	getDocIdSet(LeafReaderContext context)
int	hashCode() Override and implement query hash code properly in a subclass.

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

classHash, rewrite, sameClassAs, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

queryShape

protected final com.spatial4j.core.shape.Shape queryShape

fieldName

protected final String fieldName

grid

protected final SpatialPrefixTree grid

detailLevel

protected final int detailLevel

Constructor Detail

AbstractPrefixTreeQuery

public AbstractPrefixTreeQuery(com.spatial4j.core.shape.Shape queryShape,
                               String fieldName,
                               SpatialPrefixTree grid,
                               int detailLevel)

Method Detail

equals

public boolean equals(Object o)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly. Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.

Specified by:

equals in class Query

See Also:

Query.sameClassAs(Object), Query.classHash()

hashCode

public int hashCode()

Description copied from class: Query

Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

Query.equals(Object)

createWeight

public Weight createWeight(IndexSearcher searcher,
                           boolean needsScores)
                    throws 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

needsScores - True if document scores (Scorer.score()) or match frequencies (Scorer.freq()) are needed.

Throws:

IOException

getDocIdSet

protected abstract DocIdSet getDocIdSet(LeafReaderContext context)
                                 throws IOException

Throws:

IOException