Class ValueSourceFilter

Lucene.Net.Search.Filter that matches all documents where a Lucene.Net.Queries.Function.ValueSource is in between a range of Min and Max inclusive.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance

object

Filter

ValueSourceFilter

Inherited Members

Filter.NewAnonymous(Func<AtomicReaderContext, IBits, DocIdSet>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Spatial.Util

Assembly: Lucene.Net.Spatial.dll

Syntax

public class ValueSourceFilter : Filter

Constructors

ValueSourceFilter(Filter, ValueSource, double, double)

Lucene.Net.Search.Filter that matches all documents where a Lucene.Net.Queries.Function.ValueSource is in between a range of Min and Max inclusive.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public ValueSourceFilter(Filter startingFilter, ValueSource source, double min, double max)

Parameters

Type	Name	Description
Filter	startingFilter
ValueSource	source
double	min
double	max

Properties

Max

Lucene.Net.Search.Filter that matches all documents where a Lucene.Net.Queries.Function.ValueSource is in between a range of Min and Max inclusive.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public double Max { get; }

Property Value

Type	Description
double

Min

Lucene.Net.Search.Filter that matches all documents where a Lucene.Net.Queries.Function.ValueSource is in between a range of Min and Max inclusive.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public double Min { get; }

Property Value

Type	Description
double

Methods

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)