com.atlassian.confluence.search.contentnames
Interface ResultCategoriser

public interface ResultCategoriser

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

Method Summary

java.util.Map<Category,org.apache.lucene.search.TopScoreDocCollector>

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

Method Detail

categorise

java.util.Map<Category,org.apache.lucene.search.TopScoreDocCollector> 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 TopScoreDocCollector is assigned that category.

Parameters:

documentResultScores - the scores for each document.

resultTemplate - the required grouping of results

Returns:

results keyed by category

Throws:

java.lang.IllegalArgumentException - if documentScores or resultTemplate is null.