C# Class Lucene.Net.Facet.Range.Range

Base class for a single labeled range. @lucene.experimental
Show file Open project: apache/lucenenet Class Usage Examples

Public Methods

Method Description
GetFilter ( Lucene.Net.Queries.Function.ValueSource valueSource ) : Lucene.Net.Search.Filter

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

Returns a new Filter accepting only documents in this range. This filter is not general-purpose; you should either use it with DrillSideways by adding it to DrillDownQuery.Add, or pass it to Search.FilteredQuery using its Search.FilteredQuery.QUERY_FIRST_FILTER_STRATEGY. If the ValueSource is static, e.g. an indexed numeric field, then it may be more efficient to use 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.

Protected Methods

Method Description
FailNoMatch ( ) : void

Invoke this for a useless range.
Range ( string label )

Sole constructor.

Method Details

FailNoMatch() protected method

Invoke this for a useless range.
protected FailNoMatch ( ) : void
return void

GetFilter() public method

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

GetFilter() public abstract method

Returns a new Filter accepting only documents in this range. This filter is not general-purpose; you should either use it with DrillSideways by adding it to DrillDownQuery.Add, or pass it to Search.FilteredQuery using its Search.FilteredQuery.QUERY_FIRST_FILTER_STRATEGY. If the ValueSource is static, e.g. an indexed numeric field, then it may be more efficient to use 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.
public abstract GetFilter ( Lucene.Net.Search.Filter fastMatchFilter, Lucene.Net.Queries.Function.ValueSource valueSource ) : Lucene.Net.Search.Filter
fastMatchFilter Lucene.Net.Search.Filter
valueSource Lucene.Net.Queries.Function.ValueSource
return Lucene.Net.Search.Filter

Range() protected method

Sole constructor.
protected Range ( string label )
label string