Package org.apache.lucene.spatial.tier
Class LatLongDistanceFilter
- java.lang.Object
-
- org.apache.lucene.search.Filter
-
- org.apache.lucene.spatial.tier.DistanceFilter
-
- org.apache.lucene.spatial.tier.LatLongDistanceFilter
-
- All Implemented Interfaces:
Serializable
@Deprecated public class LatLongDistanceFilter extends DistanceFilter
Deprecated.NOTE: This API is still in flux and might change in incompatible ways in the next release.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.spatial.tier.DistanceFilter
distance, distanceLookupCache, distances, nextDocBase, precise, startingFilter
-
-
Constructor Summary
Constructors Constructor Description LatLongDistanceFilter(Filter startingFilter, double lat, double lng, double miles, String latField, String lngField)
Deprecated.Provide a distance filter based from a center point with a radius in miles.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object o)
Deprecated.Returns true ifo
is equal to this.DocIdSet
getDocIdSet(IndexReader reader)
Deprecated.Creates aDocIdSet
enumerating the documents that should be permitted in search results.int
hashCode()
Deprecated.Returns a hash code value for this object.-
Methods inherited from class org.apache.lucene.spatial.tier.DistanceFilter
getDistance, getDistances, reset, setDistances
-
-
-
-
Constructor Detail
-
LatLongDistanceFilter
public LatLongDistanceFilter(Filter startingFilter, double lat, double lng, double miles, String latField, String lngField)
Deprecated.Provide a distance filter based from a center point with a radius in miles.- Parameters:
startingFilter
- Filter to start fromlat
-lng
-miles
-latField
-lngField
-
-
-
Method Detail
-
getDocIdSet
public DocIdSet getDocIdSet(IndexReader reader) throws IOException
Deprecated.Description copied from class:Filter
Creates aDocIdSet
enumerating the documents that should be permitted in search results. NOTE: null can be returned if no documents are accepted by this Filter.Note: This method will be called once per segment in the index during searching. The returned
DocIdSet
must refer to document IDs for that segment, not for the top-level reader.- Specified by:
getDocIdSet
in classFilter
- Parameters:
reader
- aIndexReader
instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment.- Returns:
- a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null can be returned if no documents will be accepted by this Filter.
- Throws:
IOException
- See Also:
DocIdBitSet
-
equals
public boolean equals(Object o)
Deprecated.Returns true ifo
is equal to this.- Specified by:
equals
in classDistanceFilter
-
hashCode
public int hashCode()
Deprecated.Returns a hash code value for this object.- Specified by:
hashCode
in classDistanceFilter
-
-