C# Class Lucene.Net.Spatial.Prefix.WithinPrefixTreeFilter

Finds docs where its indexed shape is WITHIN the query shape. It works by looking at cells outside of the query shape to ensure documents there are excluded. By default, it will examine all cells, and it's fairly slow. If you know that the indexed shapes are never comprised of multiple disjoint parts (which also means it is not multi-valued), then you can pass SpatialPrefixTree.getDistanceForLevel(maxLevels) as the queryBuffer constructor parameter to minimally look this distance beyond the query shape's edge. Even if the indexed shapes are sometimes comprised of multiple disjoint parts, you might want to use this option with a large buffer as a faster approximation with minimal false-positives.
Inheritance: AbstractVisitingPrefixTreeFilter
Mostra file Open project: apache/lucenenet Class Usage Examples

Public Methods

Method Description
GetDocIdSet ( Lucene.Net.Index.AtomicReaderContext context, Bits acceptDocs ) : Lucene.Net.Search.DocIdSet
WithinPrefixTreeFilter ( IShape queryShape, string fieldName, SpatialPrefixTree grid, int detailLevel, int prefixGridScanLevel, double queryBuffer ) : Lucene.Net.Index

See AbstractVisitingPrefixTreeFilter.AbstractVisitingPrefixTreeFilter(IShape, string, SpatialPrefixTree, int, int). queryBuffer is the (minimum) distance beyond the query shape edge where non-matching documents are looked for so they can be excluded. If -1 is used then the whole world is examined (a good default for correctness).

Protected Methods

Method Description
BufferShape ( IShape shape, double distErr ) : IShape

Returns a new shape that is larger than shape by at distErr.

Method Details

BufferShape() protected method

Returns a new shape that is larger than shape by at distErr.
protected BufferShape ( IShape shape, double distErr ) : IShape
shape IShape
distErr double
return IShape

GetDocIdSet() public method

public GetDocIdSet ( Lucene.Net.Index.AtomicReaderContext context, Bits acceptDocs ) : Lucene.Net.Search.DocIdSet
context Lucene.Net.Index.AtomicReaderContext
acceptDocs Bits
return Lucene.Net.Search.DocIdSet

WithinPrefixTreeFilter() public method

See AbstractVisitingPrefixTreeFilter.AbstractVisitingPrefixTreeFilter(IShape, string, SpatialPrefixTree, int, int). queryBuffer is the (minimum) distance beyond the query shape edge where non-matching documents are looked for so they can be excluded. If -1 is used then the whole world is examined (a good default for correctness).
public WithinPrefixTreeFilter ( IShape queryShape, string fieldName, SpatialPrefixTree grid, int detailLevel, int prefixGridScanLevel, double queryBuffer ) : Lucene.Net.Index
queryShape IShape
fieldName string
grid Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree
detailLevel int
prefixGridScanLevel int
queryBuffer double
return Lucene.Net.Index