com.browseengine.bobo.facets.impl
Class SimpleFacetHandler

java.lang.Object
  com.browseengine.bobo.facets.FacetHandler<FacetDataCache>
      com.browseengine.bobo.facets.impl.SimpleFacetHandler

All Implemented Interfaces:

FacetScoreable

Direct Known Subclasses:

VirtualSimpleFacetHandler

public class SimpleFacetHandler
extends FacetHandler<FacetDataCache>
implements FacetScoreable

Nested Class Summary

static class	SimpleFacetHandler.SimpleBoboDocScorer
static class	SimpleFacetHandler.SimpleFacetCountCollector
static class	SimpleFacetHandler.SimpleGroupByFacetCountCollector

Nested classes/interfaces inherited from class com.browseengine.bobo.facets.FacetHandler

FacetHandler.FacetDataNone, FacetHandler.TermCountSize

Field Summary

protected String	_indexFieldName
protected TermListFactory	_termListFactory

Fields inherited from class com.browseengine.bobo.facets.FacetHandler

_name

Constructor Summary

SimpleFacetHandler(String name)

SimpleFacetHandler(String name, String indexFieldName)

SimpleFacetHandler(String name, String indexFieldName, TermListFactory termListFactory)

SimpleFacetHandler(String name, String indexFieldName, TermListFactory termListFactory, Set<String> dependsOn)

SimpleFacetHandler(String name, TermListFactory termListFactory)

SimpleFacetHandler(String name, TermListFactory termListFactory, Set<String> dependsOn)

Method Summary

RandomAccessFilter	buildRandomAccessAndFilter(String[] vals, Properties prop)
RandomAccessFilter	buildRandomAccessFilter(String value, Properties prop)
RandomAccessFilter	buildRandomAccessOrFilter(String[] vals, Properties prop, boolean isNot)
DocComparatorSource	getDocComparatorSource() builds a comparator to determine how sorting is done
BoboDocScorer	getDocScorer(BoboIndexReader reader, FacetTermScoringFunctionFactory scoringFunctionFactory, Map<String,Float> boostMap)
FacetCountCollectorSource	getFacetCountCollectorSource(BrowseSelection sel, FacetSpec ospec) Gets a FacetCountCollector
FacetCountCollectorSource	getFacetCountCollectorSource(BrowseSelection sel, FacetSpec ospec, boolean groupMode) Override this method if your facet handler have a better group mode like the SimpleFacetHandler.
String[]	getFieldValues(BoboIndexReader reader, int id) Gets the field value
Object[]	getRawFieldValues(BoboIndexReader reader, int id)
FacetDataCache	load(BoboIndexReader reader) Load information from an index reader, initialized by BoboIndexReader

Methods inherited from class com.browseengine.bobo.facets.FacetHandler

buildFilter, clone, getDependedFacetHandler, getDependsOn, getFacetData, getFieldValue, getName, getTermCountSize, load, loadFacetData, loadFacetData, merge, putDependedFacetHandler, setTermCountSize, setTermCountSize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_termListFactory

protected TermListFactory _termListFactory

_indexFieldName

protected final String _indexFieldName

Constructor Detail

SimpleFacetHandler

public SimpleFacetHandler(String name,
                          String indexFieldName,
                          TermListFactory termListFactory,
                          Set<String> dependsOn)

SimpleFacetHandler

public SimpleFacetHandler(String name,
                          TermListFactory termListFactory,
                          Set<String> dependsOn)

SimpleFacetHandler

public SimpleFacetHandler(String name,
                          String indexFieldName,
                          TermListFactory termListFactory)

SimpleFacetHandler

public SimpleFacetHandler(String name,
                          TermListFactory termListFactory)

SimpleFacetHandler

public SimpleFacetHandler(String name)

SimpleFacetHandler

public SimpleFacetHandler(String name,
                          String indexFieldName)

Method Detail

getDocComparatorSource

public DocComparatorSource getDocComparatorSource()

Description copied from class: FacetHandler

builds a comparator to determine how sorting is done

Specified by:

getDocComparatorSource in class FacetHandler<FacetDataCache>

Returns:

a sort comparator

getFieldValues

public String[] getFieldValues(BoboIndexReader reader,
                               int id)

Description copied from class: FacetHandler

Gets the field value

Specified by:

getFieldValues in class FacetHandler<FacetDataCache>

Parameters:

reader - index reader

id - doc

Returns:

array of field values

See Also:

FacetHandler.getFieldValue(BoboIndexReader,int)

getRawFieldValues

public Object[] getRawFieldValues(BoboIndexReader reader,
                                  int id)

Overrides:

getRawFieldValues in class FacetHandler<FacetDataCache>

buildRandomAccessFilter

public RandomAccessFilter buildRandomAccessFilter(String value,
                                                  Properties prop)
                                           throws IOException

Specified by:

buildRandomAccessFilter in class FacetHandler<FacetDataCache>

Throws:

IOException

buildRandomAccessAndFilter

public RandomAccessFilter buildRandomAccessAndFilter(String[] vals,
                                                     Properties prop)
                                              throws IOException

Overrides:

buildRandomAccessAndFilter in class FacetHandler<FacetDataCache>

Throws:

IOException

buildRandomAccessOrFilter

public RandomAccessFilter buildRandomAccessOrFilter(String[] vals,
                                                    Properties prop,
                                                    boolean isNot)
                                             throws IOException

Overrides:

buildRandomAccessOrFilter in class FacetHandler<FacetDataCache>

Throws:

IOException

getFacetCountCollectorSource

public FacetCountCollectorSource getFacetCountCollectorSource(BrowseSelection sel,
                                                              FacetSpec ospec)

Description copied from class: FacetHandler

Gets a FacetCountCollector

Specified by:

getFacetCountCollectorSource in class FacetHandler<FacetDataCache>

Parameters:

sel - selection

ospec - facetSpec

Returns:

a FacetCountCollector

getFacetCountCollectorSource

public FacetCountCollectorSource getFacetCountCollectorSource(BrowseSelection sel,
                                                              FacetSpec ospec,
                                                              boolean groupMode)

Description copied from class: FacetHandler

Override this method if your facet handler have a better group mode like the SimpleFacetHandler.

Overrides:

getFacetCountCollectorSource in class FacetHandler<FacetDataCache>

load

public FacetDataCache load(BoboIndexReader reader)
                    throws IOException

Description copied from class: FacetHandler

Load information from an index reader, initialized by BoboIndexReader

Specified by:

load in class FacetHandler<FacetDataCache>

Parameters:

reader - reader

Throws:

IOException

getDocScorer

public BoboDocScorer getDocScorer(BoboIndexReader reader,
                                  FacetTermScoringFunctionFactory scoringFunctionFactory,
                                  Map<String,Float> boostMap)

Specified by:

getDocScorer in interface FacetScoreable