Package org.apache.lucene.facet.facetset

Class MatchingFacetSetsCounts

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.FacetCountsWithFilterQuery

org.apache.lucene.facet.facetset.MatchingFacetSetsCounts

public class MatchingFacetSetsCounts
extends FacetCountsWithFilterQuery

Returns the counts for each given FacetSet

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

Field Summary

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

fastMatchQuery

Constructor Summary

Constructors

Constructor	Description
MatchingFacetSetsCounts(String field, FacetsCollector hits, FacetSetDecoder facetSetDecoder, FacetSetMatcher... facetSetMatchers)	Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.
MatchingFacetSetsCounts(String field, FacetsCollector hits, FacetSetDecoder facetSetDecoder, Query fastMatchQuery, FacetSetMatcher... facetSetMatchers)	Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.

Method Summary

Modifier and Type	Method	Description
FacetResult	getAllChildren(String dim, String... path)	Returns all child labels with non-zero counts under the specified path.
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.

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, toString, wait, wait, wait

Constructor Details

MatchingFacetSetsCounts

public MatchingFacetSetsCounts(String field,
 FacetsCollector hits,
 FacetSetDecoder facetSetDecoder,
 FacetSetMatcher... facetSetMatchers)
                        throws IOException

Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher.

Throws:

IOException

MatchingFacetSetsCounts

public MatchingFacetSetsCounts(String field,
 FacetsCollector hits,
 FacetSetDecoder facetSetDecoder,
 Query fastMatchQuery,
 FacetSetMatcher... facetSetMatchers)
                        throws IOException

Constructs a new instance of matching facet set counts which calculates the counts for each given facet set matcher. If fastMatchQuery is not null, then only documents which are matched by it will be counted.

Throws:

IOException

Method Details

getAllChildren

public FacetResult getAllChildren(String dim,
 String... path)
                           throws IOException

Description copied from class: Facets

Returns all child labels with non-zero counts under the specified path. Users should make no assumptions about ordering of the children. Returns null if the specified path doesn't exist or if this dimension was never seen.

Specified by:

getAllChildren in class Facets

Throws:

IOException

getTopChildren

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

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

Throws:

IOException

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