|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.Collector org.apache.lucene.facet.search.FacetsCollector
public class FacetsCollector
Collector for facet accumulation. *
Field Summary | |
---|---|
protected FacetsAccumulator |
facetsAccumulator
|
Constructor Summary | |
---|---|
FacetsCollector(FacetSearchParams facetSearchParams,
org.apache.lucene.index.IndexReader indexReader,
TaxonomyReader taxonomyReader)
Create a collector for accumulating facets while collecting documents during search. |
Method Summary | |
---|---|
boolean |
acceptsDocsOutOfOrder()
|
void |
collect(int doc)
|
List<FacetResult> |
getFacetResults()
Return accumulated facets results (according to faceted search parameters) for collected documents. |
protected FacetsAccumulator |
initFacetsAccumulator(FacetSearchParams facetSearchParams,
org.apache.lucene.index.IndexReader indexReader,
TaxonomyReader taxonomyReader)
Create the FacetsAccumulator to be used. |
protected ScoredDocIdCollector |
initScoredDocCollector(FacetSearchParams facetSearchParams,
org.apache.lucene.index.IndexReader indexReader,
TaxonomyReader taxonomyReader)
Create a ScoredDocIdCollector to be used as the first phase of
the facet collection. |
void |
setNextReader(org.apache.lucene.index.IndexReader reader,
int docBase)
|
void |
setScorer(org.apache.lucene.search.Scorer scorer)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final FacetsAccumulator facetsAccumulator
Constructor Detail |
---|
public FacetsCollector(FacetSearchParams facetSearchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)
facetSearchParams
- faceted search parameters defining which facets are required and
how.indexReader
- searched index.taxonomyReader
- taxonomy containing the facets.Method Detail |
---|
protected ScoredDocIdCollector initScoredDocCollector(FacetSearchParams facetSearchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)
ScoredDocIdCollector
to be used as the first phase of
the facet collection. If all facetRequests are do not require the
document score, a ScoredDocIdCollector which does not store the document
scores would be returned. Otherwise a SDIC which does store the documents
will be returned, having an initial allocated space for 1000 such
documents' scores.
protected FacetsAccumulator initFacetsAccumulator(FacetSearchParams facetSearchParams, org.apache.lucene.index.IndexReader indexReader, TaxonomyReader taxonomyReader)
FacetsAccumulator
to be used. Default is
StandardFacetsAccumulator
. Called once at the constructor of the collector.
facetSearchParams
- The search params.indexReader
- A reader to the index to search in.taxonomyReader
- A reader to the active taxonomy.
FacetsAccumulator
to use.public List<FacetResult> getFacetResults() throws IOException
IOException
- on errorpublic boolean acceptsDocsOutOfOrder()
acceptsDocsOutOfOrder
in class org.apache.lucene.search.Collector
public void collect(int doc) throws IOException
collect
in class org.apache.lucene.search.Collector
IOException
public void setNextReader(org.apache.lucene.index.IndexReader reader, int docBase) throws IOException
setNextReader
in class org.apache.lucene.search.Collector
IOException
public void setScorer(org.apache.lucene.search.Scorer scorer) throws IOException
setScorer
in class org.apache.lucene.search.Collector
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |