com.browseengine.bobo.api

Interface Browsable

All Superinterfaces:

AutoCloseable, Closeable, org.apache.lucene.search.Searchable

All Known Implementing Classes:

BoboBrowser, BoboSubBrowser, MultiBoboBrowser

public interface Browsable
extends org.apache.lucene.search.Searchable

Method Summary

Methods

Modifier and Type	Method and Description
BrowseResult	browse(BrowseRequest req)
void	browse(BrowseRequest req, org.apache.lucene.search.Collector hitCollector, Map<String,FacetAccessible> facets)
void	browse(BrowseRequest req, org.apache.lucene.search.Collector hitCollector, Map<String,FacetAccessible> facets, int start)
void	browse(BrowseRequest req, org.apache.lucene.search.Weight weight, org.apache.lucene.search.Collector hitCollector, Map<String,FacetAccessible> facets, int start)
org.apache.lucene.search.Explanation	explain(org.apache.lucene.search.Query q, int docid)
FacetHandler<?>	getFacetHandler(String name)
Map<String,FacetHandler<?>>	getFacetHandlerMap()
Set<String>	getFacetNames()
String[]	getFieldVal(int docid, String fieldname)
Object[]	getRawFieldVal(int docid, String fieldname)
org.apache.lucene.search.Similarity	getSimilarity()
SortCollector	getSortCollector(org.apache.lucene.search.SortField[] sort, org.apache.lucene.search.Query q, int offset, int count, boolean fetchStoredFields, Set<String> termVectorsToFetch, boolean forceScoring, String[] groupBy, int maxPerGroup, boolean collectDocIdCache)
int	numDocs()
void	setFacetHandler(FacetHandler<?> facetHandler)
void	setSimilarity(org.apache.lucene.search.Similarity similarity)

Methods inherited from interface org.apache.lucene.search.Searchable

close, doc, doc, docFreq, docFreqs, explain, maxDoc, rewrite, search, search, search

Method Detail

browse

void browse(BrowseRequest req,
          org.apache.lucene.search.Collector hitCollector,
          Map<String,FacetAccessible> facets)
            throws BrowseException

Throws:

BrowseException

browse

void browse(BrowseRequest req,
          org.apache.lucene.search.Collector hitCollector,
          Map<String,FacetAccessible> facets,
          int start)
            throws BrowseException

Throws:

BrowseException

browse

void browse(BrowseRequest req,
          org.apache.lucene.search.Weight weight,
          org.apache.lucene.search.Collector hitCollector,
          Map<String,FacetAccessible> facets,
          int start)
            throws BrowseException

Throws:

BrowseException

browse

BrowseResult browse(BrowseRequest req)
                    throws BrowseException

Throws:

BrowseException

getFacetNames

Set<String> getFacetNames()

setFacetHandler

void setFacetHandler(FacetHandler<?> facetHandler)
                     throws IOException

Throws:

IOException

getFacetHandler

FacetHandler<?> getFacetHandler(String name)

getFacetHandlerMap

Map<String,FacetHandler<?>> getFacetHandlerMap()

getSimilarity

org.apache.lucene.search.Similarity getSimilarity()

setSimilarity

void setSimilarity(org.apache.lucene.search.Similarity similarity)

getFieldVal

String[] getFieldVal(int docid,
                   String fieldname)
                     throws IOException

Throws:

IOException

getRawFieldVal

Object[] getRawFieldVal(int docid,
                      String fieldname)
                        throws IOException

Throws:

IOException

numDocs

int numDocs()

getSortCollector

SortCollector getSortCollector(org.apache.lucene.search.SortField[] sort,
                             org.apache.lucene.search.Query q,
                             int offset,
                             int count,
                             boolean fetchStoredFields,
                             Set<String> termVectorsToFetch,
                             boolean forceScoring,
                             String[] groupBy,
                             int maxPerGroup,
                             boolean collectDocIdCache)

explain

org.apache.lucene.search.Explanation explain(org.apache.lucene.search.Query q,
                                           int docid)
                                             throws IOException

Throws:

IOException