com.atlassian.confluence.search.contentnames.lucene
Class DefaultResultCategoriser

java.lang.Object
  com.atlassian.confluence.search.contentnames.lucene.DefaultResultCategoriser

All Implemented Interfaces:

ResultCategoriser

public class DefaultResultCategoriser
extends java.lang.Object
implements ResultCategoriser

Constructor Summary

DefaultResultCategoriser(CategoryMapperFactory categoryMapper)

Method Summary

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultResultCategoriser

public DefaultResultCategoriser(CategoryMapperFactory categoryMapper)

Method Detail

categorise

public java.util.Map<Category,org.apache.lucene.search.TopDocCollector> categorise(DocumentResultScores resultScores,
                                                                                   ResultTemplate resultTemplate)

Description copied from interface: ResultCategoriser

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.

Specified by:

categorise in interface ResultCategoriser

Parameters:

resultScores - the scores for each document.

resultTemplate - the required grouping of results

Returns:

results keyed by category