Module org.apache.lucene.facet

Package org.apache.lucene.facet.range

Class RangeFacetCounts

java.lang.Object

org.apache.lucene.facet.Facets

org.apache.lucene.facet.FacetCountsWithFilterQuery

org.apache.lucene.facet.range.RangeFacetCounts

Direct Known Subclasses:

DoubleRangeFacetCounts, LongRangeFacetCounts

abstract class RangeFacetCounts
extends FacetCountsWithFilterQuery

Base class for range faceting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RangeFacetCounts.Entry	Reusable entry to hold range label and int count.

Field Summary

Fields

Modifier and Type	Field	Description
protected int[]	counts	Counts.
protected final String	field	Our field name.
protected final Range[]	ranges	Ranges passed to constructor.
protected int	totCount	Total number of hits.

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

fastMatchQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RangeFacetCounts(String field, Range[] ranges, Query fastMatchQuery)	Create RangeFacetCounts

Method Summary

Modifier and Type	Method	Description
protected void	count(String field, List<FacetsCollector.MatchingDocs> matchingDocs)	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.
protected abstract LongRange[]	getLongRanges()
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.
protected long	mapDocValue(long l)
protected LongRangeCounter	setupCounter()
String	toString()
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, wait, wait, wait

Field Details

ranges

protected final Range[] ranges

Ranges passed to constructor.

counts

protected int[] counts

Counts.

field

protected final String field

Our field name.

totCount

protected int totCount

Total number of hits.

Constructor Details

RangeFacetCounts

protected RangeFacetCounts(String field,
 Range[] ranges,
 Query fastMatchQuery)

Create RangeFacetCounts

Method Details

getLongRanges

protected abstract LongRange[] getLongRanges()

mapDocValue

protected long mapDocValue(long l)

setupCounter

protected LongRangeCounter setupCounter()

count

protected void count(String field,
 List<FacetsCollector.MatchingDocs> matchingDocs)
              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

toString

public String toString()

Overrides:

toString in class Object

validateDimAndPathForGetChildren

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