org.opencms.search
Class CmsSearchCategoryCollector

java.lang.Object
  org.apache.lucene.search.HitCollector
      org.opencms.search.CmsSearchCategoryCollector

public class CmsSearchCategoryCollector
extends HitCollector

Collects category information during a search process.

Please note: The calculation of the category count slows down the search time by an order of magnitude. Make sure that you only use this feature if it's really required! Be especially careful if your search result list can become large (> 1000 documents), since in this case overall system performance will certainly be impacted considerably when calculating the categories.

Since:

6.0.0

Version:

$Revision: 1.6 $

Author:

Alexander Kandzior

Field Summary

static String

UNKNOWN_CATEGORY Category used in case the document belongs to no category.

Constructor Summary

CmsSearchCategoryCollector(IndexSearcher searcher)
Creates a new category search collector instance.

Method Summary

void	collect(int id, float score)
static String	formatCategoryMap(Map categories) Convenience method to format a map of categories in a nice 2 column list, for example for display of debugging output.
Map	getCategoryCountResult() Returns the category count result, the returned map contains Strings (category names) mapped to an Integer (the count).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_CATEGORY

public static final String UNKNOWN_CATEGORY

Category used in case the document belongs to no category.

See Also:

Constant Field Values

Constructor Detail

CmsSearchCategoryCollector

public CmsSearchCategoryCollector(IndexSearcher searcher)

Creates a new category search collector instance.

Parameters:

searcher - the index searcher used

Method Detail

formatCategoryMap

public static final String formatCategoryMap(Map categories)

Convenience method to format a map of categories in a nice 2 column list, for example for display of debugging output.

Parameters:

categories - the map to format

Returns:

the formatted category map

collect

public void collect(int id,
                    float score)

Specified by:

collect in class HitCollector

See Also:

HitCollector.collect(int, float)

getCategoryCountResult

public Map getCategoryCountResult()

Returns the category count result, the returned map contains Strings (category names) mapped to an Integer (the count).

Returns:

the category count result

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()