Package org.apache.lucene.facet
Class FacetsCollector
- java.lang.Object
-
- org.apache.lucene.search.SimpleCollector
-
- org.apache.lucene.facet.FacetsCollector
-
- All Implemented Interfaces:
Collector,LeafCollector
- Direct Known Subclasses:
RandomSamplingFacetsCollector
public class FacetsCollector extends SimpleCollector
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFacetsCollector.MatchingDocsHolds the documents that were matched in theLeafReaderContext.
-
Constructor Summary
Constructors Constructor Description FacetsCollector()Default constructorFacetsCollector(boolean keepScores)Create this; ifkeepScoresis true then a float[] is allocated to hold score of all hits.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidcollect(int doc)protected voiddoSetNextReader(LeafReaderContext context)voidfinish()booleangetKeepScores()True if scores were saved.List<FacetsCollector.MatchingDocs>getMatchingDocs()Returns the documents matched by the query, oneFacetsCollector.MatchingDocsper visited segment.ScoreModescoreMode()static TopDocssearch(IndexSearcher searcher, Query q, int n, Collector fc)Deprecated.static TopFieldDocssearch(IndexSearcher searcher, Query q, int n, Sort sort, boolean doDocScores, Collector fc)Deprecated.static TopFieldDocssearch(IndexSearcher searcher, Query q, int n, Sort sort, Collector fc)Deprecated.static TopDocssearchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Collector fc)Deprecated.static TopDocssearchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, boolean doDocScores, Collector fc)static TopDocssearchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, Collector fc)voidsetScorer(Scorable scorer)-
Methods inherited from class org.apache.lucene.search.SimpleCollector
getLeafCollector
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.LeafCollector
collect, competitiveIterator
-
-
-
-
Method Detail
-
getKeepScores
public final boolean getKeepScores()
True if scores were saved.
-
getMatchingDocs
public List<FacetsCollector.MatchingDocs> getMatchingDocs()
Returns the documents matched by the query, oneFacetsCollector.MatchingDocsper visited segment.
-
collect
public void collect(int doc) throws IOException- Specified by:
collectin interfaceLeafCollector- Specified by:
collectin classSimpleCollector- Throws:
IOException
-
scoreMode
public ScoreMode scoreMode()
-
setScorer
public final void setScorer(Scorable scorer) throws IOException
- Specified by:
setScorerin interfaceLeafCollector- Overrides:
setScorerin classSimpleCollector- Throws:
IOException
-
doSetNextReader
protected void doSetNextReader(LeafReaderContext context) throws IOException
- Overrides:
doSetNextReaderin classSimpleCollector- Throws:
IOException
-
finish
public void finish() throws IOException- Throws:
IOException
-
search
@Deprecated public static TopDocs search(IndexSearcher searcher, Query q, int n, Collector fc) throws IOException
Deprecated.Utility method, to search and also collect all hits into the providedCollector.- Throws:
IOException
-
search
@Deprecated public static TopFieldDocs search(IndexSearcher searcher, Query q, int n, Sort sort, Collector fc) throws IOException
Deprecated.Utility method, to search and also collect all hits into the providedCollector.- Throws:
IOException
-
search
@Deprecated public static TopFieldDocs search(IndexSearcher searcher, Query q, int n, Sort sort, boolean doDocScores, Collector fc) throws IOException
Deprecated.Utility method, to search and also collect all hits into the providedCollector.- Throws:
IOException
-
searchAfter
@Deprecated public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Collector fc) throws IOException
Deprecated.Utility method, to search and also collect all hits into the providedCollector.- Throws:
IOException
-
searchAfter
@Deprecated public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, Collector fc) throws IOException
Deprecated.Utility method, to search and also collect all hits into the providedCollector.- Throws:
IOException
-
searchAfter
@Deprecated public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, boolean doDocScores, Collector fc) throws IOException
Deprecated.Utility method, to search and also collect all hits into the providedCollector.- Throws:
IOException
-
-