Package org.apache.lucene.facet
Class LongValueFacetCounts
java.lang.Object
org.apache.lucene.facet.Facets
org.apache.lucene.facet.LongValueFacetCounts
Facets
implementation that computes counts for all unique long values, more efficiently
counting small values (0-1023) using an int array, and switching to a HashMap
for
values above 1023. Retrieve all facet counts, in value order, with getAllChildrenSortByValue()
, or get the topN values sorted by count with getTopChildrenSortByCount(int)
.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Constructor Summary
ConstructorDescriptionLongValueFacetCounts
(String field, FacetsCollector hits) CreateLongValueFacetCounts
, using either single-valuedNumericDocValues
or multi-valuedSortedNumericDocValues
from the specified field (depending on what has been indexed).LongValueFacetCounts
(String field, MultiLongValuesSource valuesSource, FacetsCollector hits) CreateLongValueFacetCounts
, using the providedMultiLongValuesSource
if non-null.LongValueFacetCounts
(String field, MultiLongValuesSource valuesSource, IndexReader reader) Counts all facet values for the providedMultiLongValuesSource
if non-null.LongValueFacetCounts
(String field, IndexReader reader) Counts all facet values for this reader.LongValueFacetCounts
(String field, LongValuesSource valueSource, FacetsCollector hits) CreateLongValueFacetCounts
, using the providedLongValuesSource
if non-null.LongValueFacetCounts
(String field, LongValuesSource valueSource, IndexReader reader) Counts all facet values for the providedLongValuesSource
if non-null. -
Method Summary
Modifier and TypeMethodDescriptionReturns all unique values seen, sorted by value.getAllDims
(int topN) Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.getSpecificValue
(String dim, String... path) Return the count or value for a specific path.getTopChildren
(int topN, String dim, String... path) Returns the topN child labels under the specified path.getTopChildrenSortByCount
(int topN) Returns the specified top number of facets, sorted by count.toString()
-
Constructor Details
-
LongValueFacetCounts
CreateLongValueFacetCounts
, using either single-valuedNumericDocValues
or multi-valuedSortedNumericDocValues
from the specified field (depending on what has been indexed).- Throws:
IOException
-
LongValueFacetCounts
public LongValueFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits) throws IOException CreateLongValueFacetCounts
, using the providedLongValuesSource
if non-null. IfvalueSource
is null, doc values from the providedfield
will be used.- Throws:
IOException
-
LongValueFacetCounts
public LongValueFacetCounts(String field, MultiLongValuesSource valuesSource, FacetsCollector hits) throws IOException CreateLongValueFacetCounts
, using the providedMultiLongValuesSource
if non-null. IfvaluesSource
is null, doc values from the providedfield
will be used.- Throws:
IOException
-
LongValueFacetCounts
Counts all facet values for this reader. This produces the same result as computing facets on aMatchAllDocsQuery
, but is more efficient.- Throws:
IOException
-
LongValueFacetCounts
public LongValueFacetCounts(String field, LongValuesSource valueSource, IndexReader reader) throws IOException Counts all facet values for the providedLongValuesSource
if non-null. IfvalueSource
is null, doc values from the providedfield
will be used. This produces the same result as computing facets on aMatchAllDocsQuery
, but is more efficient.- Throws:
IOException
-
LongValueFacetCounts
public LongValueFacetCounts(String field, MultiLongValuesSource valuesSource, IndexReader reader) throws IOException Counts all facet values for the providedMultiLongValuesSource
if non-null. IfvalueSource
is null, doc values from the providedfield
will be used. This produces the same result as computing facets on aMatchAllDocsQuery
, but is more efficient.- Throws:
IOException
-
-
Method Details
-
getTopChildren
Description copied from class:Facets
Returns the topN child labels under the specified path. Returns null if the specified path doesn't exist or if this dimension was never seen.- Specified by:
getTopChildren
in classFacets
-
getTopChildrenSortByCount
Returns the specified top number of facets, sorted by count. -
getAllChildrenSortByValue
Returns all unique values seen, sorted by value. -
getSpecificValue
Description copied from class:Facets
Return the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.- Specified by:
getSpecificValue
in classFacets
-
getAllDims
Description copied from class:Facets
Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.- Specified by:
getAllDims
in classFacets
-
toString
-