Package org.opencms.search.documents
Interface I_CmsTermHighlighter
-
- All Known Implementing Classes:
CmsTermHighlighterHtml
public interface I_CmsTermHighlighter
Highlights arbitrary terms, used for generation of search excerpts.- Since:
- 6.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.
-
-
-
Method Detail
-
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.- Parameters:
doc
- the content Lucene document to generate the excerpt forindex
- the index that has been searchedparams
- the current search parametersquery
- the search queryanalyzer
- the analyzer used- Returns:
- an excerpt of the content
- Throws:
java.io.IOException
- if something goes wrongorg.apache.lucene.search.highlight.InvalidTokenOffsetsException
- in case of problems with the Lucene tokenizer
-
-