public class FacetsCollector extends Collector
Modifier and Type | Class and Description |
---|---|
static class |
FacetsCollector.MatchingDocs
Holds the documents that were matched in the
AtomicReaderContext . |
Constructor and Description |
---|
FacetsCollector()
Default constructor
|
FacetsCollector(boolean keepScores)
Create this; if
keepScores is true then a
float[] is allocated to hold score of all hits. |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptsDocsOutOfOrder()
Return
true if this collector does not
require the matching docIDs to be delivered in int sort
order (smallest to largest) to Collector.collect(int) . |
void |
collect(int doc)
Called once for every document matching a query, with the unbased document
number.
|
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)
Called before collecting from each
AtomicReaderContext . |
void |
setScorer(Scorer scorer)
Called before successive calls to
Collector.collect(int) . |
public FacetsCollector()
public FacetsCollector(boolean keepScores)
keepScores
is true then a
float[] is allocated to hold score of all hits.public final boolean getKeepScores()
public List<FacetsCollector.MatchingDocs> getMatchingDocs()
FacetsCollector.MatchingDocs
per
visited segment.public final boolean acceptsDocsOutOfOrder()
Collector
true
if this collector does not
require the matching docIDs to be delivered in int sort
order (smallest to largest) to Collector.collect(int)
.
Most Lucene Query implementations will visit
matching docIDs in order. However, some queries
(currently limited to certain cases of BooleanQuery
) can achieve faster searching if the
Collector
allows them to deliver the
docIDs out of order.
Many collectors don't mind getting docIDs out of
order, so it's important to return true
here.
acceptsDocsOutOfOrder
in class Collector
public final void collect(int doc) throws IOException
Collector
Note: The collection of the current segment can be terminated by throwing
a CollectionTerminatedException
. In this case, the last docs of the
current AtomicReaderContext
will be skipped and IndexSearcher
will swallow the exception and continue collection with the next leaf.
Note: This is called in an inner search loop. For good search performance,
implementations of this method should not call IndexSearcher.doc(int)
or
IndexReader.document(int)
on every hit.
Doing so can slow searches by an order of magnitude or more.
collect
in class Collector
IOException
public final void setScorer(Scorer scorer) throws IOException
Collector
Collector.collect(int)
. Implementations
that need the score of the current document (passed-in to
Collector.collect(int)
), should save the passed-in Scorer and call
scorer.score() when needed.setScorer
in class Collector
IOException
public final void setNextReader(AtomicReaderContext context) throws IOException
Collector
AtomicReaderContext
. All doc ids in
Collector.collect(int)
will correspond to IndexReaderContext.reader()
.
Add AtomicReaderContext.docBase
to the current IndexReaderContext.reader()
's
internal document id to re-base ids in Collector.collect(int)
.setNextReader
in class Collector
context
- next atomic reader contextIOException
public static TopDocs search(IndexSearcher searcher, Query q, int n, Collector fc) throws IOException
Collector
.IOException
public static TopDocs search(IndexSearcher searcher, Query q, Filter filter, int n, Collector fc) throws IOException
Collector
.IOException
public static TopFieldDocs search(IndexSearcher searcher, Query q, Filter filter, int n, Sort sort, Collector fc) throws IOException
Collector
.IOException
public static TopFieldDocs search(IndexSearcher searcher, Query q, Filter filter, int n, Sort sort, boolean doDocScores, boolean doMaxScore, Collector fc) throws IOException
Collector
.IOException
public TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, int n, Collector fc) throws IOException
Collector
.IOException
public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, Filter filter, int n, Collector fc) throws IOException
Collector
.IOException
public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, Filter filter, int n, Sort sort, Collector fc) throws IOException
Collector
.IOException
public static TopDocs searchAfter(IndexSearcher searcher, ScoreDoc after, Query q, Filter filter, int n, Sort sort, boolean doDocScores, boolean doMaxScore, Collector fc) throws IOException
Collector
.IOException
Copyright © 2010 - 2020 Adobe. All Rights Reserved