public class FacetsCollector extends Collector
Modifier and Type | Field and Description |
---|---|
protected FacetsAccumulator |
facetsAccumulator |
Constructor and Description |
---|
FacetsCollector(FacetSearchParams facetSearchParams,
IndexReader indexReader,
TaxonomyReader taxonomyReader)
Create a collector for accumulating facets while collecting documents
during search.
|
Modifier and Type | Method and Description |
---|---|
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,
IndexReader indexReader,
TaxonomyReader taxonomyReader)
Create the
FacetsAccumulator to be used. |
protected ScoredDocIdCollector |
initScoredDocCollector(FacetSearchParams facetSearchParams,
IndexReader indexReader,
TaxonomyReader taxonomyReader)
Create a
ScoredDocIdCollector to be used as the first phase of
the facet collection. |
void |
setNextReader(AtomicReaderContext context) |
void |
setScorer(Scorer scorer) |
protected final FacetsAccumulator facetsAccumulator
public FacetsCollector(FacetSearchParams facetSearchParams, IndexReader indexReader, TaxonomyReader taxonomyReader)
facetSearchParams
- faceted search parameters defining which facets are required and
how.indexReader
- searched index.taxonomyReader
- taxonomy containing the facets.protected ScoredDocIdCollector initScoredDocCollector(FacetSearchParams facetSearchParams, 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, 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 Collector
public void collect(int doc) throws IOException
collect
in class Collector
IOException
public void setNextReader(AtomicReaderContext context) throws IOException
setNextReader
in class Collector
IOException
public void setScorer(Scorer scorer) throws IOException
setScorer
in class Collector
IOException
Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.