|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.search.v2.lucene.LuceneSubsetResultFilter
public class LuceneSubsetResultFilter
A result filter that filters out all but a particular "window" (offset from start, count) of results. Depending on the number of results in the hit set being filtered, there may be fewer than count results returned, or even none at all.
If offset is zero, has the effect of limiting the number of results.
Constructor Summary | |
---|---|
LuceneSubsetResultFilter(int count)
Construct a filter that returns at most the first count hits. |
|
LuceneSubsetResultFilter(int startOffset,
int count)
Construct a filter with the given start offset and count. |
Method Summary | |
---|---|
int |
getExpectedResultsCount()
The number of results that the filter expects to allow into the final search result. |
boolean |
isIncludedInResults(WrappedHit hit)
|
boolean |
shouldContinueIterating()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LuceneSubsetResultFilter(int count)
count
hits. This is the
equivalent of new LuceneSubsetResultFilter(0, count)
.
count
- the number of hits to returnpublic LuceneSubsetResultFilter(int startOffset, int count)
startOffset
- the zero-based offset of the first hit to returncount
- the maximum number of hits to returnMethod Detail |
---|
public boolean isIncludedInResults(WrappedHit hit)
isIncludedInResults
in interface LuceneResultFilter
LuceneResultFilter.isIncludedInResults(WrappedHit)
public boolean shouldContinueIterating()
shouldContinueIterating
in interface LuceneResultFilter
LuceneResultFilter.shouldContinueIterating()
public int getExpectedResultsCount()
LuceneResultFilter
getExpectedResultsCount
in interface LuceneResultFilter
LuceneResultFilter.getExpectedResultsCount()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |