org.opencms.search.documents

接口 I_CmsTermHighlighter

所有已知实现类:

CmsTermHighlighterHtml

public interface I_CmsTermHighlighter

Highlights arbitrary terms, used for generation of search excerpts.

从以下版本开始:

6.0.0

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getExcerpt(org.apache.lucene.document.Document doc, CmsSearchIndex index, CmsSearchParameters params, org.apache.lucene.search.Query query, org.apache.lucene.analysis.Analyzer analyzer) Returns an excerpt of the given document related based on the given index and query.

方法详细资料

getExcerpt

java.lang.String getExcerpt(org.apache.lucene.document.Document doc,
                          CmsSearchIndex index,
                          CmsSearchParameters params,
                          org.apache.lucene.search.Query query,
                          org.apache.lucene.analysis.Analyzer analyzer)
                            throws java.io.IOException,
                                   org.apache.lucene.search.highlight.InvalidTokenOffsetsException

Returns an excerpt of the given document related based on the given index and query.

参数:

doc - the content Lucene document to generate the excerpt for

index - the index that has been searched

params - the current search parameters

query - the search query

analyzer - the analyzer used

返回:

an excerpt of the content

抛出:

java.io.IOException - if something goes wrong

org.apache.lucene.search.highlight.InvalidTokenOffsetsException - in case of problems with the Lucene tokenizer