Module org.apache.lucene.facet

Package org.apache.lucene.facet.rangeonrange

Class RangeOnRangeFacetCounts

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.FacetCountsWithFilterQuery

org.apache.lucene.facet.rangeonrange.RangeOnRangeFacetCounts

Direct Known Subclasses:

DoubleRangeOnRangeFacetCounts, LongRangeOnRangeFacetCounts

abstract class RangeOnRangeFacetCounts
extends FacetCountsWithFilterQuery

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RangeOnRangeFacetCounts.Entry

Field Summary

Fields

Modifier and Type	Field	Description
private final int[]	counts	Counts, initialized in by subclass.
private final String	field	Our field name.
private final String[]	labels
private int	totCount	Total number of hits.

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

fastMatchQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RangeOnRangeFacetCounts(String field, FacetsCollector hits, RangeFieldQuery.QueryType queryType, Query fastMatchQuery, int numEncodedValueBytes, byte[][] encodedRanges, String[] labels)

Method Summary

Modifier and Type	Method	Description
protected void	count(String field, List<FacetsCollector.MatchingDocs> matchingDocs, byte[][] encodedRanges, int numEncodedValueBytes, RangeFieldQuery.QueryType queryType)	Counts from the provided field.
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.
private void	validateDimAndPathForGetChildren(String dim, String... 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

Field Details

labels

private final String[] labels

counts

private final int[] counts

Counts, initialized in by subclass.

field

private final String field

Our field name.

totCount

private int totCount

Total number of hits.

Constructor Details

RangeOnRangeFacetCounts

protected RangeOnRangeFacetCounts(String field,
 FacetsCollector hits,
 RangeFieldQuery.QueryType queryType,
 Query fastMatchQuery,
 int numEncodedValueBytes,
 byte[][] encodedRanges,
 String[] labels)
                           throws IOException

Throws:

IOException

Method Details

count

protected void count(String field,
 List<FacetsCollector.MatchingDocs> matchingDocs,
 byte[][] encodedRanges,
 int numEncodedValueBytes,
 RangeFieldQuery.QueryType queryType)
              throws IOException

Counts from the provided field.

Throws:

IOException

getAllChildren

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

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.

NOTE: This implementation guarantees that ranges will be returned in the order specified by the user when calling the constructor.

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

validateDimAndPathForGetChildren

private void validateDimAndPathForGetChildren(String dim,
 String... path)