Class ContainsPrefixTreeFilter

Finds docs where its indexed shape Contains the query shape. For use on RecursivePrefixTreeStrategy.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
object
Filter
AbstractPrefixTreeFilter
ContainsPrefixTreeFilter
Inherited Members
Namespace: Lucene.Net.Spatial.Prefix
Assembly: Lucene.Net.Spatial.dll
Syntax
public class ContainsPrefixTreeFilter : AbstractPrefixTreeFilter

Constructors

ContainsPrefixTreeFilter(IShape, string, SpatialPrefixTree, int, bool)

Finds docs where its indexed shape Contains the query shape. For use on RecursivePrefixTreeStrategy.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration
public ContainsPrefixTreeFilter(IShape queryShape, string fieldName, SpatialPrefixTree grid, int detailLevel, bool multiOverlappingIndexedShapes)
Parameters
Type Name Description
IShape queryShape
string fieldName
SpatialPrefixTree grid
int detailLevel
bool multiOverlappingIndexedShapes

Fields

m_multiOverlappingIndexedShapes

If the spatial data for a document is comprised of multiple overlapping or adjacent parts, it might fail to match a query shape when doing the CONTAINS predicate when the sum of those shapes contain the query shape but none do individually. Set this to false to increase performance if you don't care about that circumstance (such as if your indexed data doesn't even have such conditions). See LUCENE-5062.

Declaration
protected readonly bool m_multiOverlappingIndexedShapes
Field Value
Type Description
bool

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? o)
Parameters
Type Name Description
object o
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetDocIdSet(AtomicReaderContext, IBits)

Creates a Lucene.Net.Search.DocIdSet enumerating the documents that should be permitted in search results. NOTE:null can be returned if no documents are accepted by this Lucene.Net.Search.Filter.

Note: this method will be called once per segment in the index during searching. The returned Lucene.Net.Search.DocIdSet must refer to document IDs for that segment, not for the top-level reader.
Declaration
public override DocIdSet? GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)
Parameters
Type Name Description
AtomicReaderContext context

a Lucene.Net.Index.AtomicReaderContext instance opened on the index currently searched on. Note, it is likely that the provided reader info 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. The provided context is always an atomic context, so you can call Lucene.Net.Index.AtomicReader.Fields on the context's reader, for example.
IBits acceptDocs

Lucene.Net.Util.IBits that represent the allowable docs to match (typically deleted docs but possibly filtering other documents)
Returns
Type Description
DocIdSet

A Lucene.Net.Search.DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE:null should be returned if the filter doesn't accept any documents otherwise internal optimization might not apply in the case an emptyLucene.Net.Search.DocIdSet is returned.
Overrides
Lucene.Net.Search.Filter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext, Lucene.Net.Util.IBits)

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides