com.atlassian.confluence.search.v2.lucene

Interface LuceneResultFilter

All Known Implementing Classes:

LuceneSubsetResultFilter, NullResultFilter

Deprecated.

since 5.5. Please implement a search time Filter instead. If you must perform post search filtering, you can filter SearchResults returned by the methods on SearchManager.

@Deprecated
public interface LuceneResultFilter

Performs filtering of search results after a search has complete.

Please note, this is different to a Filter which filters results during a search (which is generally more efficient).

Method Summary

Modifier and Type	Method and Description
int	getExpectedResultsCount() Deprecated. The number of results that the filter expects to allow into the final search result.
boolean	isIncludedInResults(WrappedHit hit) Deprecated.
boolean	shouldContinueIterating() Deprecated.

Method Detail

isIncludedInResults

boolean isIncludedInResults(WrappedHit hit)

Deprecated.

shouldContinueIterating

boolean shouldContinueIterating()

Deprecated.

getExpectedResultsCount

int getExpectedResultsCount()

Deprecated.

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.