org.hibernate.search.spatial.impl

Class SpatialHashFilter

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.Filter

org.hibernate.search.spatial.impl.SpatialHashFilter

All Implemented Interfaces:

Cloneable

public final class SpatialHashFilter
extends org.apache.lucene.search.Filter

Lucene Filter for filtering documents which have been indexed with Hibernate Search Spatial SpatialFieldBridge Use denormalized spatial hash cell ids to return a sub set of documents near the center

Author:

Nicolas Helleringer

See Also:

SpatialFieldBridgeByHash, Coordinates

Constructor Summary

Constructors

Constructor and Description
SpatialHashFilter(List<String> spatialHashCellsIds, String fieldName)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.DocIdSet	getDocIdSet(org.apache.lucene.index.LeafReaderContext context, org.apache.lucene.util.Bits acceptDocs) Search the index for document having the correct spatial hash cell id at given grid level.
String	getFieldName()
List<String>	getSpatialHashCellsIds()
String	toString(String field)

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

rewrite

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialHashFilter

public SpatialHashFilter(List<String> spatialHashCellsIds,
                         String fieldName)

Method Detail

getDocIdSet

public org.apache.lucene.search.DocIdSet getDocIdSet(org.apache.lucene.index.LeafReaderContext context,
                                                     org.apache.lucene.util.Bits acceptDocs)
                                              throws IOException

Search the index for document having the correct spatial hash cell id at given grid level.

Specified by:

getDocIdSet in class org.apache.lucene.search.Filter

Parameters:

context - the LeafReaderContext for which to return the DocIdSet.

acceptDocs - Bits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)

Returns:

a DocIdSet with the document ids matching

Throws:

IOException

getSpatialHashCellsIds

public List<String> getSpatialHashCellsIds()

getFieldName

public String getFieldName()

toString

public String toString(String field)

Specified by:

toString in class org.apache.lucene.search.Query