com.browseengine.bobo.api

Interface FacetAccessible

All Known Subinterfaces:

FacetCountCollector

All Known Implementing Classes:

AttributesFacetCountCollector, BucketFacetCountCollector, CombinedFacetAccessible, DefaultFacetCountCollector, GeoFacetCountCollector, GeoSimpleFacetCountCollector, GroupByFacetCountCollector, HistogramFacetHandler.HistogramCollector, MappedFacetAccessible, MultiValuedPathFacetCountCollector, MultiValueFacetHandler.MultiValueFacetCountCollector, PathFacetCountCollector, RangeFacetCountCollector, SimpleFacetHandler.SimpleFacetCountCollector, SimpleFacetHandler.SimpleGroupByFacetCountCollector

public interface FacetAccessible

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Responsible for release resources used.
BrowseFacet	getFacet(String value) Gets the facet given a value.
int	getFacetHitsCount(Object value) Gets the facet count given a value.
List<BrowseFacet>	getFacets() Gets gathered top facets
FacetIterator	iterator() Returns an iterator to visit all the facets

Method Detail

getFacets

List<BrowseFacet> getFacets()

Gets gathered top facets

Returns:

list of facets

getFacet

BrowseFacet getFacet(String value)

Gets the facet given a value. This is a way for random accessing into the facet data structure.

Parameters:

value - Facet value

Returns:

a facet with count filled in

getFacetHitsCount

int getFacetHitsCount(Object value)

Gets the facet count given a value. This is a way for random accessing the facet count.

Parameters:

value - Facet value

Returns:

a facet with count filled in

close

void close()

Responsible for release resources used. If the implementing class does not use a lot of resources, it does not have to do anything.

iterator

FacetIterator iterator()

Returns an iterator to visit all the facets

Returns:

Returns a FacetIterator to iterate over all the facets