Module org.apache.lucene.facet

Package org.apache.lucene.facet.range

Class DoubleRangeFacetCounts

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.FacetCountsWithFilterQuery

org.apache.lucene.facet.range.RangeFacetCounts

org.apache.lucene.facet.range.DoubleRangeFacetCounts

public class DoubleRangeFacetCounts
extends RangeFacetCounts

Facets implementation that computes counts for dynamic double ranges. Use this for dimensions that change in real-time (e.g. a relative time based dimension like "Past day", "Past 2 days", etc.) or that change for each request (e.g. distance from the user's location, "< 1 km", "< 2 km", etc.).

If you have indexed your field using FloatDocValuesField, then you should use a DoubleValuesSource generated from DoubleValuesSource.fromFloatField(String).

Field Summary

Fields inherited from class org.apache.lucene.facet.range.RangeFacetCounts

counts, field, ranges, totCount

Fields inherited from class org.apache.lucene.facet.FacetCountsWithFilterQuery

fastMatchQuery

Constructor Summary

Constructors

Constructor	Description
DoubleRangeFacetCounts(String field, FacetsCollector hits, DoubleRange... ranges)	Create RangeFacetCounts, using double value from the specified field.
DoubleRangeFacetCounts(String field, MultiDoubleValuesSource valuesSource, FacetsCollector hits, DoubleRange... ranges)	Create RangeFacetCounts, using the provided MultiDoubleValuesSource if non-null.
DoubleRangeFacetCounts(String field, MultiDoubleValuesSource valuesSource, FacetsCollector hits, Query fastMatchQuery, DoubleRange... ranges)	Create RangeFacetCounts, using the provided MultiDoubleValuesSource if non-null.
DoubleRangeFacetCounts(String field, DoubleValuesSource valueSource, FacetsCollector hits, DoubleRange... ranges)	Create RangeFacetCounts, using the provided DoubleValuesSource if non-null.
DoubleRangeFacetCounts(String field, DoubleValuesSource valueSource, FacetsCollector hits, Query fastMatchQuery, DoubleRange... ranges)	Create RangeFacetCounts, using the provided DoubleValuesSource if non-null.

Method Summary

Modifier and Type	Method	Description
private void	count(MultiDoubleValuesSource valueSource, List<FacetsCollector.MatchingDocs> matchingDocs)	Counts from the provided valueSource.
private void	count(DoubleValuesSource valueSource, List<FacetsCollector.MatchingDocs> matchingDocs)	Counts from the provided valueSource.
protected LongRange[]	getLongRanges()	Create long ranges from the double ranges.
protected long	mapDocValue(long l)

Methods inherited from class org.apache.lucene.facet.range.RangeFacetCounts

count, getAllChildren, getAllDims, getSpecificValue, getTopChildren, setupCounter, toString

Methods inherited from class org.apache.lucene.facet.FacetCountsWithFilterQuery

createIterator

Methods inherited from class org.apache.lucene.facet.Facets

getTopDims, validateTopN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DoubleRangeFacetCounts

public DoubleRangeFacetCounts(String field,
 FacetsCollector hits,
 DoubleRange... ranges)
                       throws IOException

Create RangeFacetCounts, using double value from the specified field. The field may be single-valued (NumericDocValues) or multi-valued (SortedNumericDocValues), and will be interpreted as containing double values.

N.B This assumes that the field was indexed with DoubleDocValuesField. For float-valued fields, use DoubleRangeFacetCounts(String, DoubleValuesSource, FacetsCollector, DoubleRange...) or DoubleRangeFacetCounts(String, MultiDoubleValuesSource, FacetsCollector, DoubleRange...)

TODO: Extend multi-valued support to fields that have been indexed as float values

Throws:

IOException

DoubleRangeFacetCounts

public DoubleRangeFacetCounts(String field,
 DoubleValuesSource valueSource,
 FacetsCollector hits,
 DoubleRange... ranges)
                       throws IOException

Create RangeFacetCounts, using the provided DoubleValuesSource if non-null. If valueSource is null, doc values from the provided field will be used.

N.B If relying on the provided field, see javadoc notes associated with DoubleRangeFacetCounts(String, FacetsCollector, DoubleRange...) for assumptions on how the field is indexed.

Throws:

IOException

DoubleRangeFacetCounts

public DoubleRangeFacetCounts(String field,
 MultiDoubleValuesSource valuesSource,
 FacetsCollector hits,
 DoubleRange... ranges)
                       throws IOException

Create RangeFacetCounts, using the provided MultiDoubleValuesSource if non-null. If valuesSource is null, doc values from the provided field will be used.

N.B If relying on the provided field, see javadoc notes associated with DoubleRangeFacetCounts(String, FacetsCollector, DoubleRange...) for assumptions on how the field is indexed.

Throws:

IOException

DoubleRangeFacetCounts

public DoubleRangeFacetCounts(String field,
 DoubleValuesSource valueSource,
 FacetsCollector hits,
 Query fastMatchQuery,
 DoubleRange... ranges)
                       throws IOException

Create RangeFacetCounts, using the provided DoubleValuesSource if non-null. If valueSource is null, doc values from the provided field will be used. Use the provided Query as a fastmatch: only documents matching the query are checked for the matching ranges.

N.B If relying on the provided field, see javadoc notes associated with DoubleRangeFacetCounts(String, FacetsCollector, DoubleRange...) for assumptions on how the field is indexed.

Throws:

IOException

DoubleRangeFacetCounts

public DoubleRangeFacetCounts(String field,
 MultiDoubleValuesSource valuesSource,
 FacetsCollector hits,
 Query fastMatchQuery,
 DoubleRange... ranges)
                       throws IOException

Create RangeFacetCounts, using the provided MultiDoubleValuesSource if non-null. If valuesSource is null, doc values from the provided field will be used. Use the provided Query as a fastmatch: only documents matching the query are checked for the matching ranges.

N.B If relying on the provided field, see javadoc notes associated with DoubleRangeFacetCounts(String, FacetsCollector, DoubleRange...) for assumptions on how the field is indexed.

Throws:

IOException

Method Details

count

private void count(DoubleValuesSource valueSource,
 List<FacetsCollector.MatchingDocs> matchingDocs)
            throws IOException

Counts from the provided valueSource.

Throws:

IOException

count

private void count(MultiDoubleValuesSource valueSource,
 List<FacetsCollector.MatchingDocs> matchingDocs)
            throws IOException

Counts from the provided valueSource.

Throws:

IOException

getLongRanges

protected LongRange[] getLongRanges()

Create long ranges from the double ranges.

Specified by:

getLongRanges in class RangeFacetCounts

mapDocValue

protected long mapDocValue(long l)

Overrides:

mapDocValue in class RangeFacetCounts