Summary: Methods | [Expand All]
public interface

LuceneResultFilter

com.atlassian.confluence.search.v2.lucene.LuceneResultFilter
Known Indirect Subclasses

Summary

Public Methods
int getExpectedResultsCount()
The number of results that the filter expects to allow into the final search result.
boolean isIncludedInResults(WrappedHit hit)
boolean shouldContinueIterating()

Public Methods

public int getExpectedResultsCount ()

The number of results that the filter expects to allow into the final search result. This is used as a purely advisory number to initialise the size of collections, and so on. Returning a number less than or equal to zero indicates that the filter has no idea how many results it is likely to return.

Returns
  • the number of results the filter expects to permit in the search results, or zero if no prediction can be made.

public boolean isIncludedInResults (WrappedHit hit)

public boolean shouldContinueIterating ()