com.browseengine.bobo.facets.impl
Class RangeFacetHandler

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

All Implemented Interfaces:

FacetScoreable

Direct Known Subclasses:

MultiRangeFacetHandler

public class RangeFacetHandler
extends FacetHandler<FacetDataCache>
implements FacetScoreable

Nested Class Summary

static class

RangeFacetHandler.RangeBoboDocScorer

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

FacetHandler.FacetDataNone, FacetHandler.TermCountSize

Field Summary

protected String	_indexFieldName
protected List<String>	_predefinedRanges
protected TermListFactory	_termListFactory

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

_name

Constructor Summary

RangeFacetHandler(String name, List<String> predefinedRanges)

RangeFacetHandler(String name, String indexFieldName, List<String> predefinedRanges)

RangeFacetHandler(String name, String indexFieldName, TermListFactory termListFactory, List<String> predefinedRanges)

RangeFacetHandler(String name, TermListFactory termListFactory, List<String> predefinedRanges)

Method Summary

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
String[]	getFieldValues(BoboIndexReader reader, int id) Gets the field value
int	getNumItems(BoboIndexReader reader, int id)
Object[]	getRawFieldValues(BoboIndexReader reader, int id)
boolean	hasPredefinedRanges()
FacetDataCache	load(BoboIndexReader reader) Load information from an index reader, initialized by BoboIndexReader

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

buildFilter, buildRandomAccessAndFilter, clone, getDependedFacetHandler, getDependsOn, getFacetCountCollectorSource, 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

_indexFieldName

protected final String _indexFieldName

_termListFactory

protected final TermListFactory _termListFactory

_predefinedRanges

protected final List<String> _predefinedRanges

Constructor Detail

RangeFacetHandler

public RangeFacetHandler(String name,
                         String indexFieldName,
                         TermListFactory termListFactory,
                         List<String> predefinedRanges)

RangeFacetHandler

public RangeFacetHandler(String name,
                         TermListFactory termListFactory,
                         List<String> predefinedRanges)

RangeFacetHandler

public RangeFacetHandler(String name,
                         List<String> predefinedRanges)

RangeFacetHandler

public RangeFacetHandler(String name,
                         String indexFieldName,
                         List<String> predefinedRanges)

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

getNumItems

public int getNumItems(BoboIndexReader reader,
                       int id)

Overrides:

getNumItems in class FacetHandler<FacetDataCache>

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

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

hasPredefinedRanges

public boolean hasPredefinedRanges()

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