org.opencms.search

类 CmsSearchCategoryCollector

java.lang.Object

org.apache.lucene.search.Collector

org.opencms.search.CmsSearchCategoryCollector

public class CmsSearchCategoryCollector
extends org.apache.lucene.search.Collector

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.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	UNKNOWN_CATEGORY Category used in case the document belongs to no category.

构造器概要

构造器

构造器和说明
CmsSearchCategoryCollector(org.apache.lucene.search.IndexSearcher searcher) Creates a new category search collector instance.

方法概要

方法

限定符和类型	方法和说明
boolean	acceptsDocsOutOfOrder()
void	collect(int id)
static java.lang.String	formatCategoryMap(java.util.Map<java.lang.String,java.lang.Integer> categories) Convenience method to format a map of categories in a nice 2 column list, for example for display of debugging output.
java.util.Map<java.lang.String,java.lang.Integer>	getCategoryCountResult() Returns the category count result, the returned map contains Strings (category names) mapped to an Integer (the count).
void	setNextReader(org.apache.lucene.index.AtomicReaderContext ctx)
void	setScorer(org.apache.lucene.search.Scorer arg0)
java.lang.String	toString()

从类继承的方法 java.lang.Object

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

字段详细资料

UNKNOWN_CATEGORY

public static final java.lang.String UNKNOWN_CATEGORY

Category used in case the document belongs to no category.

另请参阅:

常量字段值

构造器详细资料

CmsSearchCategoryCollector

public CmsSearchCategoryCollector(org.apache.lucene.search.IndexSearcher searcher)

Creates a new category search collector instance.

参数:

searcher - the index searcher used

方法详细资料

formatCategoryMap

public static final java.lang.String formatCategoryMap(java.util.Map<java.lang.String,java.lang.Integer> categories)

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

参数:

categories - the map to format

返回:

the formatted category map

acceptsDocsOutOfOrder

public boolean acceptsDocsOutOfOrder()

指定者:

acceptsDocsOutOfOrder 在类中 org.apache.lucene.search.Collector

另请参阅:

Collector.acceptsDocsOutOfOrder()

collect

public void collect(int id)

指定者:

collect 在类中 org.apache.lucene.search.Collector

另请参阅:

Collector.collect(int)

getCategoryCountResult

public java.util.Map<java.lang.String,java.lang.Integer> getCategoryCountResult()

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

返回:

the category count result

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext ctx)

指定者:

setNextReader 在类中 org.apache.lucene.search.Collector

另请参阅:

Collector.setNextReader(org.apache.lucene.index.AtomicReaderContext)

setScorer

public void setScorer(org.apache.lucene.search.Scorer arg0)

指定者:

setScorer 在类中 org.apache.lucene.search.Collector

另请参阅:

Collector.setScorer(org.apache.lucene.search.Scorer)

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()