org.apache.lucene.facet

Class LongValueFacetCounts

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.LongValueFacetCounts

public class LongValueFacetCounts
extends Facets

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

Constructors

Constructor and Description
LongValueFacetCounts(String field, FacetsCollector hits, boolean multiValued) Create LongValueFacetCounts, using either single-valued NumericDocValues or multi-valued SortedNumericDocValues from the specified field.
LongValueFacetCounts(String field, IndexReader reader, boolean multiValued) Counts all facet values for this reader.
LongValueFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits) Create LongValueFacetCounts, using the provided LongValuesSource.
LongValueFacetCounts(String field, LongValuesSource valueSource, FacetsCollector hits, boolean multiValued) Create LongValueFacetCounts, using the provided LongValuesSource.
LongValueFacetCounts(String field, LongValuesSource valueSource, IndexReader reader) Counts all facet values for the provided LongValuesSource.

Method Summary

Modifier and Type	Method and Description
FacetResult	getAllChildrenSortByValue() Returns all unique values seen, sorted by value.
List<FacetResult>	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.
Number	getSpecificValue(String dim, String... path) Return the count or value for a specific path.
FacetResult	getTopChildren(int topN, String dim, String... path) Returns the topN child labels under the specified path.
FacetResult	getTopChildrenSortByCount(int topN) Returns the specified top number of facets, sorted by count.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LongValueFacetCounts

public LongValueFacetCounts(String field,
                            FacetsCollector hits,
                            boolean multiValued)
                     throws IOException

Create LongValueFacetCounts, using either single-valued NumericDocValues or multi-valued SortedNumericDocValues from the specified field.

Throws:

IOException

LongValueFacetCounts

public LongValueFacetCounts(String field,
                            LongValuesSource valueSource,
                            FacetsCollector hits)
                     throws IOException

Create LongValueFacetCounts, using the provided LongValuesSource. If hits is null then all facets are counted.

Throws:

IOException

LongValueFacetCounts

public LongValueFacetCounts(String field,
                            LongValuesSource valueSource,
                            FacetsCollector hits,
                            boolean multiValued)
                     throws IOException

Create LongValueFacetCounts, using the provided LongValuesSource. random access (implement DocIdSet.bits()).

Throws:

IOException

LongValueFacetCounts

public LongValueFacetCounts(String field,
                            IndexReader reader,
                            boolean multiValued)
                     throws IOException

Counts all facet values for this reader. This produces the same result as computing facets on a MatchAllDocsQuery, but is more efficient.

Throws:

IOException

LongValueFacetCounts

public LongValueFacetCounts(String field,
                            LongValuesSource valueSource,
                            IndexReader reader)
                     throws IOException

Counts all facet values for the provided LongValuesSource. This produces the same result as computing facets on a MatchAllDocsQuery, but is more efficient.

Throws:

IOException

Method Detail

getTopChildren

public FacetResult getTopChildren(int topN,
                                  String dim,
                                  String... path)

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 class Facets

getTopChildrenSortByCount

public FacetResult getTopChildrenSortByCount(int topN)

Returns the specified top number of facets, sorted by count.

getAllChildrenSortByValue

public FacetResult getAllChildrenSortByValue()

Returns all unique values seen, sorted by value.

getSpecificValue

public Number getSpecificValue(String dim,
                               String... path)
                        throws IOException

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 class Facets

Throws:

IOException

getAllDims

public List<FacetResult> getAllDims(int topN)
                             throws IOException

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 class Facets

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object