com.browseengine.bobo.api.Browsable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bobo-browse Show documentation

Bobo is a Faceted Search implementation written purely in Java, an extension of Apache Lucene

The newest version!

package com.browseengine.bobo.api;

import java.io.IOException;
import java.util.Map;
import java.util.Set;

import org.apache.lucene.index.IndexReader;
import org.apache.lucene.search.Collector;
import org.apache.lucene.search.Explanation;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.SortField;
import org.apache.lucene.search.similarities.Similarity;

import com.browseengine.bobo.facets.FacetHandler;
import com.browseengine.bobo.sort.SortCollector;

public interface Browsable {

  void browse(BrowseRequest req, Collector hitCollector, Map facets,
      int start) throws BrowseException;

  IndexReader getIndexReader();

  BrowseResult browse(BrowseRequest req) throws BrowseException;

  Set getFacetNames();

  void setFacetHandler(FacetHandler facetHandler) throws IOException;

  FacetHandler getFacetHandler(String name);

  Map> getFacetHandlerMap();

  void setSimilarity(Similarity similarity);

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

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

  int numDocs();

  SortCollector getSortCollector(SortField[] sort, Query q, int offset, int count,
      boolean fetchStoredFields, Set termVectorsToFetch, String[] groupBy, int maxPerGroup,
      boolean collectDocIdCache);

  void doClose() throws IOException;

  Explanation explain(Query q, int deBasedDoc) throws IOException;
}