org.apache.lucene.facet
Class FacetsCollector

java.lang.Object
  org.apache.lucene.search.Collector
      org.apache.lucene.facet.FacetsCollector

public class FacetsCollector
extends Collector

Collects hits for subsequent faceting. Once you've run a search and collect hits into this, instantiate one of the Facets subclasses to do the facet counting. Use the search utility methods to perform an "ordinary" search but also collect into a Collector.

Nested Class Summary

protected static class	FacetsCollector.Docs Used during collection to record matching docs and then return a DocIdSet that contains them.
static class	FacetsCollector.MatchingDocs Holds the documents that were matched in the AtomicReaderContext.

Constructor Summary

FacetsCollector()
Default constructor

FacetsCollector(boolean keepScores)
Create this; if keepScores is true then a float[] is allocated to hold score of all hits.

Method Summary

boolean	acceptsDocsOutOfOrder()
void	collect(int doc)
protected FacetsCollector.Docs	createDocs(int maxDoc) Creates a FacetsCollector.Docs to record hits.
boolean	getKeepScores() True if scores were saved.
List<FacetsCollector.MatchingDocs>	getMatchingDocs() Returns the documents matched by the query, one FacetsCollector.MatchingDocs per visited segment.
static TopDocs	search(IndexSearcher searcher, Query q, Filter filter, int n, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
static TopFieldDocs	search(IndexSearcher searcher, Query q, Filter filter, int n, Sort sort, boolean doDocScores, boolean doMaxScore, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
static TopFieldDocs	search(IndexSearcher searcher, Query q, Filter filter, int n, Sort sort, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
static TopDocs	search(IndexSearcher searcher, Query q, int n, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
static TopDocs	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, Filter filter, int n, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
static TopDocs	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, Filter filter, int n, Sort sort, boolean doDocScores, boolean doMaxScore, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
static TopDocs	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, Filter filter, int n, Sort sort, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
TopDocs	searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Collector fc) Utility method, to search and also collect all hits into the provided Collector.
void	setNextReader(AtomicReaderContext context)
void	setScorer(Scorer scorer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FacetsCollector

public FacetsCollector()

Default constructor

FacetsCollector

public FacetsCollector(boolean keepScores)

Create this; if keepScores is true then a float[] is allocated to hold score of all hits.

Method Detail

createDocs

protected FacetsCollector.Docs createDocs(int maxDoc)

Creates a FacetsCollector.Docs to record hits. The default uses FixedBitSet to record hits and you can override to e.g. record the docs in your own DocIdSet.

getKeepScores

public final boolean getKeepScores()

True if scores were saved.

getMatchingDocs

public List<FacetsCollector.MatchingDocs> getMatchingDocs()

Returns the documents matched by the query, one FacetsCollector.MatchingDocs per visited segment.

acceptsDocsOutOfOrder

public final boolean acceptsDocsOutOfOrder()

Specified by:

acceptsDocsOutOfOrder in class Collector

collect

public final void collect(int doc)
                   throws IOException

Specified by:

collect in class Collector

Throws:

IOException

setScorer

public final void setScorer(Scorer scorer)
                     throws IOException

Specified by:

setScorer in class Collector

Throws:

IOException

setNextReader

public final void setNextReader(AtomicReaderContext context)
                         throws IOException

Specified by:

setNextReader in class Collector

Throws:

IOException

search

public static TopDocs search(IndexSearcher searcher,
                             Query q,
                             int n,
                             Collector fc)
                      throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

search

public static TopDocs search(IndexSearcher searcher,
                             Query q,
                             Filter filter,
                             int n,
                             Collector fc)
                      throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

search

public static TopFieldDocs search(IndexSearcher searcher,
                                  Query q,
                                  Filter filter,
                                  int n,
                                  Sort sort,
                                  Collector fc)
                           throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

search

public static TopFieldDocs search(IndexSearcher searcher,
                                  Query q,
                                  Filter filter,
                                  int n,
                                  Sort sort,
                                  boolean doDocScores,
                                  boolean doMaxScore,
                                  Collector fc)
                           throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

searchAfter

public TopDocs searchAfter(IndexSearcher searcher,
                           ScoreDoc after,
                           Query q,
                           int n,
                           Collector fc)
                    throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

searchAfter

public static TopDocs searchAfter(IndexSearcher searcher,
                                  ScoreDoc after,
                                  Query q,
                                  Filter filter,
                                  int n,
                                  Collector fc)
                           throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

searchAfter

public static TopDocs searchAfter(IndexSearcher searcher,
                                  ScoreDoc after,
                                  Query q,
                                  Filter filter,
                                  int n,
                                  Sort sort,
                                  Collector fc)
                           throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException

searchAfter

public static TopDocs searchAfter(IndexSearcher searcher,
                                  ScoreDoc after,
                                  Query q,
                                  Filter filter,
                                  int n,
                                  Sort sort,
                                  boolean doDocScores,
                                  boolean doMaxScore,
                                  Collector fc)
                           throws IOException

Utility method, to search and also collect all hits into the provided Collector.

Throws:

IOException