Module org.apache.lucene.facet

Package org.apache.lucene.facet.range

Class LongRangeFacetCounts

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.FacetCountsWithFilterQuery

org.apache.lucene.facet.range.RangeFacetCounts

org.apache.lucene.facet.range.LongRangeFacetCounts

public class LongRangeFacetCounts
extends RangeFacetCounts

Facets implementation that computes counts for dynamic long 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.).

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
LongRangeFacetCounts(String field, FacetsCollector hits, LongRange... ranges)	Create LongRangeFacetCounts using long values from the specified field.
LongRangeFacetCounts(String field, MultiLongValuesSource valuesSource, FacetsCollector hits, LongRange... ranges)	Create LongRangeFacetCounts, using the provided MultiLongValuesSource if non-null.
LongRangeFacetCounts(String field, MultiLongValuesSource valuesSource, FacetsCollector hits, Query fastMatchQuery, LongRange... ranges)	Create LongRangeFacetCounts, using the provided MultiLongValuesSource if non-null.
LongRangeFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits, LongRange... ranges)	Create LongRangeFacetCounts, using the provided LongValuesSource if non-null.
LongRangeFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits, Query fastMatchQuery, LongRange... ranges)	Create LongRangeFacetCounts, using the provided LongValuesSource if non-null.

Method Summary

Modifier and Type	Method	Description
private void	count(MultiLongValuesSource valueSource, List<FacetsCollector.MatchingDocs> matchingDocs)	Counts from the provided valueSource.
private void	count(LongValuesSource valueSource, List<FacetsCollector.MatchingDocs> matchingDocs)	Counts from the provided valueSource.
protected LongRange[]	getLongRanges()

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

count, getAllChildren, getAllDims, getSpecificValue, getTopChildren, mapDocValue, 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

LongRangeFacetCounts

public LongRangeFacetCounts(String field,
 FacetsCollector hits,
 LongRange... ranges)
                     throws IOException

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

Throws:

IOException

LongRangeFacetCounts

public LongRangeFacetCounts(String field,
 LongValuesSource valueSource,
 FacetsCollector hits,
 LongRange... ranges)
                     throws IOException

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

Throws:

IOException

LongRangeFacetCounts

public LongRangeFacetCounts(String field,
 MultiLongValuesSource valuesSource,
 FacetsCollector hits,
 LongRange... ranges)
                     throws IOException

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

Throws:

IOException

LongRangeFacetCounts

public LongRangeFacetCounts(String field,
 LongValuesSource valueSource,
 FacetsCollector hits,
 Query fastMatchQuery,
 LongRange... ranges)
                     throws IOException

Create LongRangeFacetCounts, using the provided LongValuesSource 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 passing the filter are checked for the matching ranges, which is helpful when the provided LongValuesSource is costly per-document, such as a geo distance.

Throws:

IOException

LongRangeFacetCounts

public LongRangeFacetCounts(String field,
 MultiLongValuesSource valuesSource,
 FacetsCollector hits,
 Query fastMatchQuery,
 LongRange... ranges)
                     throws IOException

Create LongRangeFacetCounts, using the provided MultiLongValuesSource 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 passing the filter are checked for the matching ranges, which is helpful when the provided LongValuesSource is costly per-document, such as a geo distance.

Throws:

IOException

Method Details

count

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

Counts from the provided valueSource.

Throws:

IOException

count

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

Counts from the provided valueSource.

Throws:

IOException

getLongRanges

protected LongRange[] getLongRanges()

Specified by:

getLongRanges in class RangeFacetCounts