Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Properties | List of all members
Lucene.Net.Search.NumericRangeFilter< T > Class Template Reference

A Filter that only accepts numeric values within a specified range. To use this, you must first index the numeric values using NumericField (expert: NumericTokenStream ). More...

Inherits Lucene.Net.Search.MultiTermQueryWrapperFilter< T >.

Properties

string Field [get]
 Returns the field name for this filter
 
bool IncludesMin [get]
 Returns true if the lower endpoint is inclusive
 
bool IncludesMax [get]
 Returns true if the upper endpoint is inclusive
 
Min [get]
 Returns the lower value of this range filter
 
Max [get]
 Returns the upper value of this range filter
 
- Properties inherited from Lucene.Net.Search.MultiTermQueryWrapperFilter< T >
virtual int TotalNumberOfTerms [get]
 Expert: Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index. This method is not thread safe, be sure to only call it when no filter is running! If you re-use the same filter instance for another search, be sure to first reset the term counter with ClearTotalNumberOfTerms.
 

Additional Inherited Members

- Public Member Functions inherited from Lucene.Net.Search.MultiTermQueryWrapperFilter< T >
override System.String ToString ()
 
override bool Equals (System.Object o)
 
override int GetHashCode ()
 
virtual void ClearTotalNumberOfTerms ()
 Expert: Resets the counting of unique terms. Do this before executing the filter.
 
override DocIdSet GetDocIdSet (IndexReader reader)
 
 

Detailed Description

A Filter that only accepts numeric values within a specified range. To use this, you must first index the numeric values using NumericField (expert: NumericTokenStream ).

You create a new NumericRangeFilter with the static factory methods, eg:

Filter f = NumericRangeFilter.newFloatRange("weight", new Float(0.3f), new Float(0.10f), true, true);

accepts all documents whose float valued "weight" field ranges from 0.3 to 0.10, inclusive. See NumericRangeQuery{T} for details on how Lucene indexes and searches numeric valued fields.

<font color="red">NOTE: This API is experimental and might change in incompatible ways in the next release.</font>

<since> 2.9

</since>

Type Constraints
T :struct 
T :IComparable<T> 

Definition at line 55 of file NumericRangeFilter.cs.

Property Documentation

string Lucene.Net.Search.NumericRangeFilter< T >.Field
get

Returns the field name for this filter

Definition at line 66 of file NumericRangeFilter.cs.

bool Lucene.Net.Search.NumericRangeFilter< T >.IncludesMax
get

Returns true if the upper endpoint is inclusive

Definition at line 78 of file NumericRangeFilter.cs.

bool Lucene.Net.Search.NumericRangeFilter< T >.IncludesMin
get

Returns true if the lower endpoint is inclusive

Definition at line 72 of file NumericRangeFilter.cs.

T Lucene.Net.Search.NumericRangeFilter< T >.Max
get

Returns the upper value of this range filter

Definition at line 90 of file NumericRangeFilter.cs.

T Lucene.Net.Search.NumericRangeFilter< T >.Min
get

Returns the lower value of this range filter

Definition at line 84 of file NumericRangeFilter.cs.


The documentation for this class was generated from the following file: