com.browseengine.bobo.facets
Interface FacetCountCollector

All Superinterfaces:
FacetAccessible
All Known Implementing Classes:
BucketFacetCountCollector, DefaultFacetCountCollector, GeoFacetCountCollector, GeoSimpleFacetCountCollector, GroupByFacetCountCollector, HistogramFacetHandler.HistogramCollector, MultiValuedPathFacetCountCollector, MultiValueFacetHandler.MultiValueFacetCountCollector, PathFacetCountCollector, RangeFacetCountCollector, SimpleFacetHandler.SimpleFacetCountCollector, SimpleFacetHandler.SimpleGroupByFacetCountCollector

public interface FacetCountCollector
extends FacetAccessible

Collects facet counts for a given browse request


Field Summary
static List<BrowseFacet> EMPTY_FACET_LIST
          Empty facet list.
 
Method Summary
 void collect(int docid)
          Collect a hit.
 void collectAll()
          Collects all hits.
 int[] getCountDistribution()
          Returns an integer array representing the distribution function of a given facet.
 String getName()
          Gets the name of the facet
 
Methods inherited from interface com.browseengine.bobo.api.FacetAccessible
close, getFacet, getFacets, iterator
 

Field Detail

EMPTY_FACET_LIST

static final List<BrowseFacet> EMPTY_FACET_LIST
Empty facet list.

Method Detail

collect

void collect(int docid)
Collect a hit. This is called for every hit, thus the implementation needs to be super-optimized.

Parameters:
docid - doc

collectAll

void collectAll()
Collects all hits. This is called once per request by the facet engine in certain scenarios.


getName

String getName()
Gets the name of the facet

Returns:
facet name

getCountDistribution

int[] getCountDistribution()
Returns an integer array representing the distribution function of a given facet.

Returns:
integer array of count values representing distribution of the facet values.


Copyright © 2011. All Rights Reserved.