org.apache.lucene.facet.range
Class RangeFacetRequest<T extends Range>

java.lang.Object
  org.apache.lucene.facet.search.FacetRequest
      org.apache.lucene.facet.range.RangeFacetRequest<T>

public class RangeFacetRequest<T extends Range>
extends FacetRequest

Facet request for dynamic ranges based on a NumericDocValues field. This does not use the taxonomy index nor any indexed facet values.

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.facet.search.FacetRequest

FacetRequest.ResultMode, FacetRequest.SortOrder

Field Summary

Range[]

ranges

Fields inherited from class org.apache.lucene.facet.search.FacetRequest

categoryPath, numResults

Constructor Summary

RangeFacetRequest(String field, List<T> ranges)

RangeFacetRequest(String field, T... ranges)

Method Summary

FacetsAggregator

createFacetsAggregator(FacetIndexingParams fip) Returns the FacetsAggregator which can aggregate the categories of this facet request.

Methods inherited from class org.apache.lucene.facet.search.FacetRequest

equals, getDepth, getNumLabel, getResultMode, getSortOrder, hashCode, setDepth, setNumLabel, setResultMode, setSortOrder, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ranges

public final Range[] ranges

Constructor Detail

RangeFacetRequest

public RangeFacetRequest(String field,
                         T... ranges)

RangeFacetRequest

public RangeFacetRequest(String field,
                         List<T> ranges)

Method Detail

createFacetsAggregator

public FacetsAggregator createFacetsAggregator(FacetIndexingParams fip)

Description copied from class: FacetRequest

Returns the FacetsAggregator which can aggregate the categories of this facet request. The aggregator is expected to aggregate category values into FacetArrays. If the facet request does not support that, e.g. RangeFacetRequest, it can return null. Note though that such requests require a dedicated FacetsAccumulator.

Specified by:

createFacetsAggregator in class FacetRequest