com.browseengine.bobo.facets.impl

Class MultiValueFacetHandler

java.lang.Object

com.browseengine.bobo.facets.FacetHandler<MultiValueFacetDataCache>

com.browseengine.bobo.facets.impl.MultiValueFacetHandler

All Implemented Interfaces:

FacetScoreable

Direct Known Subclasses:

MultiValueWithWeightFacetHandler

public class MultiValueFacetHandler
extends FacetHandler<MultiValueFacetDataCache>
implements FacetScoreable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiValueFacetHandler.MultiValueDocScorer
static class	MultiValueFacetHandler.MultiValueFacetCountCollector

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

FacetHandler.FacetDataNone, FacetHandler.TermCountSize

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	_depends
protected String	_indexFieldName
protected int	_maxItems
protected org.apache.lucene.index.Term	_sizePayloadTerm
protected TermListFactory	_termListFactory

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

_name

Constructor Summary

Constructors

Constructor and Description
MultiValueFacetHandler(String name)
MultiValueFacetHandler(String name, Set<String> depends)
MultiValueFacetHandler(String name, String indexFieldName)
MultiValueFacetHandler(String name, String indexFieldName, TermListFactory termListFactory)
MultiValueFacetHandler(String name, String indexFieldName, TermListFactory termListFactory, org.apache.lucene.index.Term sizePayloadTerm)
MultiValueFacetHandler(String name, String indexFieldName, TermListFactory termListFactory, org.apache.lucene.index.Term sizePayloadTerm, Set<String> depends)
MultiValueFacetHandler(String name, TermListFactory termListFactory)
MultiValueFacetHandler(String name, TermListFactory termListFactory, org.apache.lucene.index.Term sizePayloadTerm)

Method Summary

Methods

Modifier and Type	Method and Description
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
String[]	getFieldValues(BoboIndexReader reader, int id) Gets the field value
int	getNumItems(BoboIndexReader reader, int id)
Object[]	getRawFieldValues(BoboIndexReader reader, int id)
MultiValueFacetDataCache	load(BoboIndexReader reader) Load information from an index reader, initialized by BoboIndexReader
MultiValueFacetDataCache	load(BoboIndexReader reader, BoboIndexReader.WorkArea workArea)
void	setMaxItems(int maxItems)

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

buildFilter, clone, getDependedFacetHandler, getDependsOn, getFacetCountCollectorSource, getFacetData, getFieldValue, getName, getTermCountSize, 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 final TermListFactory _termListFactory

_indexFieldName

protected final String _indexFieldName

_maxItems

protected int _maxItems

_sizePayloadTerm

protected org.apache.lucene.index.Term _sizePayloadTerm

_depends

protected Set<String> _depends

Constructor Detail

MultiValueFacetHandler

public MultiValueFacetHandler(String name,
                      String indexFieldName,
                      TermListFactory termListFactory,
                      org.apache.lucene.index.Term sizePayloadTerm,
                      Set<String> depends)

MultiValueFacetHandler

public MultiValueFacetHandler(String name,
                      String indexFieldName,
                      TermListFactory termListFactory,
                      org.apache.lucene.index.Term sizePayloadTerm)

MultiValueFacetHandler

public MultiValueFacetHandler(String name,
                      TermListFactory termListFactory,
                      org.apache.lucene.index.Term sizePayloadTerm)

MultiValueFacetHandler

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

MultiValueFacetHandler

public MultiValueFacetHandler(String name,
                      TermListFactory termListFactory)

MultiValueFacetHandler

public MultiValueFacetHandler(String name,
                      String indexFieldName)

MultiValueFacetHandler

public MultiValueFacetHandler(String name)

MultiValueFacetHandler

public MultiValueFacetHandler(String name,
                      Set<String> depends)

Method Detail

getNumItems

public int getNumItems(BoboIndexReader reader,
              int id)

Overrides:

getNumItems in class FacetHandler<MultiValueFacetDataCache>

getDocComparatorSource

public DocComparatorSource getDocComparatorSource()

Description copied from class: FacetHandler

builds a comparator to determine how sorting is done

Specified by:

getDocComparatorSource in class FacetHandler<MultiValueFacetDataCache>

Returns:

a sort comparator

setMaxItems

public void setMaxItems(int maxItems)

getFieldValues

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

Description copied from class: FacetHandler

Gets the field value

Specified by:

getFieldValues in class FacetHandler<MultiValueFacetDataCache>

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<MultiValueFacetDataCache>

getFacetCountCollectorSource

public FacetCountCollectorSource getFacetCountCollectorSource(BrowseSelection sel,
                                                     FacetSpec ospec)

Description copied from class: FacetHandler

Gets a FacetCountCollector

Specified by:

getFacetCountCollectorSource in class FacetHandler<MultiValueFacetDataCache>

Parameters:

sel - selection

ospec - facetSpec

Returns:

a FacetCountCollector

load

public MultiValueFacetDataCache 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<MultiValueFacetDataCache>

Parameters:

reader - reader

Throws:

IOException

load

public MultiValueFacetDataCache load(BoboIndexReader reader,
                            BoboIndexReader.WorkArea workArea)
                              throws IOException

Overrides:

load in class FacetHandler<MultiValueFacetDataCache>

Throws:

IOException

buildRandomAccessFilter

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

Specified by:

buildRandomAccessFilter in class FacetHandler<MultiValueFacetDataCache>

Throws:

IOException

buildRandomAccessAndFilter

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

Overrides:

buildRandomAccessAndFilter in class FacetHandler<MultiValueFacetDataCache>

Throws:

IOException

buildRandomAccessOrFilter

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

Overrides:

buildRandomAccessOrFilter in class FacetHandler<MultiValueFacetDataCache>

Throws:

IOException

getDocScorer

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

Specified by:

getDocScorer in interface FacetScoreable