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
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Holds the documents that were matched in theLeafReaderContext
. -
Constructor Summary
ConstructorDescriptionDefault constructorFacetsCollector
(boolean keepScores) Create this; ifkeepScores
is true then a float[] is allocated to hold score of all hits. -
Method Summary
Modifier and TypeMethodDescriptionvoid
collect
(int doc) protected void
doSetNextReader
(LeafReaderContext context) void
finish()
final boolean
True if scores were saved.Returns the documents matched by the query, oneFacetsCollector.MatchingDocs
per visited segment.static TopDocs
search
(IndexSearcher searcher, Query q, int n, Collector fc) Utility method, to search and also collect all hits into the providedCollector
.static TopFieldDocs
search
(IndexSearcher searcher, Query q, int n, Sort sort, boolean doDocScores, Collector fc) Utility method, to search and also collect all hits into the providedCollector
.static TopFieldDocs
search
(IndexSearcher searcher, Query q, int n, Sort sort, Collector fc) Utility method, to search and also collect all hits into the providedCollector
.static TopDocs
searchAfter
(IndexSearcher searcher, ScoreDoc after, Query q, int n, Collector fc) Utility method, to search and also collect all hits into the providedCollector
.static TopDocs
searchAfter
(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, boolean doDocScores, Collector fc) Utility method, to search and also collect all hits into the providedCollector
.static TopDocs
searchAfter
(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, Collector fc) Utility method, to search and also collect all hits into the providedCollector
.final void
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
-
Constructor Details
-
FacetsCollector
public FacetsCollector()Default constructor -
FacetsCollector
public FacetsCollector(boolean keepScores) Create this; ifkeepScores
is true then a float[] is allocated to hold score of all hits.
-
-
Method Details
-
getKeepScores
public final boolean getKeepScores()True if scores were saved. -
getMatchingDocs
Returns the documents matched by the query, oneFacetsCollector.MatchingDocs
per visited segment. -
collect
- Specified by:
collect
in interfaceLeafCollector
- Specified by:
collect
in classSimpleCollector
- Throws:
IOException
-
scoreMode
-
setScorer
- Specified by:
setScorer
in interfaceLeafCollector
- Overrides:
setScorer
in classSimpleCollector
- Throws:
IOException
-
doSetNextReader
- Overrides:
doSetNextReader
in classSimpleCollector
- Throws:
IOException
-
finish
- 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 providedCollector
.- Throws:
IOException
-
search
public static TopFieldDocs search(IndexSearcher searcher, Query q, int n, Sort sort, Collector fc) throws IOException Utility method, to search and also collect all hits into the providedCollector
.- Throws:
IOException
-
search
public static TopFieldDocs search(IndexSearcher searcher, Query q, int n, Sort sort, boolean doDocScores, Collector fc) throws IOException Utility method, to search and also collect all hits into the providedCollector
.- Throws:
IOException
-
searchAfter
public static 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 providedCollector
.- Throws:
IOException
-
searchAfter
public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, Collector fc) throws IOException Utility method, to search and also collect all hits into the providedCollector
.- Throws:
IOException
-
searchAfter
public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Sort sort, boolean doDocScores, Collector fc) throws IOException Utility method, to search and also collect all hits into the providedCollector
.- Throws:
IOException
-