Class Range

Base class for a single labeled range.

Note

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

Inheritance
System.Object
Range
DoubleRange
Int64Range
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Facet.Range
Assembly: Lucene.Net.Facet.dll
Syntax
public abstract class Range

Constructors

| Improve this Doc View Source

Range(String)

Sole constructor.

Declaration
protected Range(string label)
Parameters
Type Name Description
System.String label

Properties

| Improve this Doc View Source

Label

Label that identifies this range.

Declaration
public string Label { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

FailNoMatch()

Invoke this for a useless range.

Declaration
protected virtual void FailNoMatch()
| Improve this Doc View Source

GetFilter(ValueSource)

Returns a new Lucene.Net.Search.Filter accepting only documents in this range. This filter is not general-purpose; you should either use it with DrillSideways by adding it to Add(String, Filter), or pass it to Lucene.Net.Search.FilteredQuery using its QUERY_FIRST_FILTER_STRATEGY. If the Lucene.Net.Queries.Function.ValueSource is static, e.g. an indexed numeric field, then it may be more efficient to use Lucene.Net.Search.NumericRangeFilter.

Declaration
public virtual Filter GetFilter(ValueSource valueSource)
Parameters
Type Name Description
Lucene.Net.Queries.Function.ValueSource valueSource
Returns
Type Description
Lucene.Net.Search.Filter
| Improve this Doc View Source

GetFilter(Filter, ValueSource)

Returns a new Lucene.Net.Search.Filter accepting only documents in this range. This filter is not general-purpose; you should either use it with DrillSideways by adding it to Add(String, Filter), or pass it to Lucene.Net.Search.FilteredQuery using its QUERY_FIRST_FILTER_STRATEGY. If the Lucene.Net.Queries.Function.ValueSource is static, e.g. an indexed numeric field, then it may be more efficient to use Lucene.Net.Search.NumericRangeFilter. The provided fastMatchFilter, if non-null, will first be consulted, and only if that is set for each document will the range then be checked.

Declaration
public abstract Filter GetFilter(Filter fastMatchFilter, ValueSource valueSource)
Parameters
Type Name Description
Lucene.Net.Search.Filter fastMatchFilter
Lucene.Net.Queries.Function.ValueSource valueSource
Returns
Type Description
Lucene.Net.Search.Filter