com.atlassian.confluence.search.contentnames
Interface ResultCategoriser

All Known Implementing Classes:

DefaultResultCategoriser

public interface ResultCategoriser

Responsible for categorising results that are passed in as DocumentResultScores. Results are categorised according to the ResultTemplate specified.

Method Summary

Map<Category,org.apache.lucene.search.TopDocCollector>

categorise(DocumentResultScores documentResultScores, ResultTemplate resultTemplate) Categorises documentScores into categories defined in the specified resultTemplate.

Method Detail

categorise

Map<Category,org.apache.lucene.search.TopDocCollector> categorise(DocumentResultScores documentResultScores,
                                                                  ResultTemplate resultTemplate)

Categorises documentScores into categories defined in the specified resultTemplate. If no results are found for any particular category, then an empty TopDocCollector is assigned that category.

Parameters:

documentResultScores - the scores for each document.

resultTemplate - the required grouping of results

Returns:

results keyed by category

Throws:

IllegalArgumentException - if documentScores or resultTemplate is null.