com.atlassian.confluence.search.contentnames.lucene
Interface ResultConverter

All Known Implementing Classes:

DefaultResultConverter

public interface ResultConverter

Converts search results from docId's into actual SearchResults.

Method Summary

java.util.List<SearchResult>	asList(org.apache.lucene.search.TopDocsCollector results) Converts the results to a list of SearchResult, i.e.
java.util.Map<Category,java.util.List<SearchResult>>	categorise(java.util.Map<Category,org.apache.lucene.search.TopDocsCollector> results) Convert search results and categorise

Method Detail

categorise

java.util.Map<Category,java.util.List<SearchResult>> categorise(java.util.Map<Category,org.apache.lucene.search.TopDocsCollector> results)

Convert search results and categorise

Parameters:

results - results to convert

Returns:

ordered results keyed by category. Search results are ordered such that highest scoring hits come first.

asList

java.util.List<SearchResult> asList(org.apache.lucene.search.TopDocsCollector results)

Converts the results to a list of SearchResult, i.e. with no categorisation.

Parameters:

results - results to convert

Returns:

Search results are ordered such that highest scoring hits come first.