Package org.opencms.search.documents
Class CmsTermHighlighterHtml
- java.lang.Object
-
- org.opencms.search.documents.CmsTermHighlighterHtml
-
- All Implemented Interfaces:
I_CmsTermHighlighter
public class CmsTermHighlighterHtml extends java.lang.Object implements I_CmsTermHighlighter
Default highlighter implementation used for generation of search excerpts.- Since:
- 6.0.0
-
-
Constructor Summary
Constructors Constructor Description CmsTermHighlighterHtml()
-
Method Summary
All Methods Instance Methods Concrete 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.
-
-
-
Constructor Detail
-
CmsTermHighlighterHtml
public CmsTermHighlighterHtml()
-
-
Method Detail
-
getExcerpt
public 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
Description copied from interface:I_CmsTermHighlighter
Returns an excerpt of the given document related based on the given index and query.- Specified by:
getExcerpt
in interfaceI_CmsTermHighlighter
- 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- See Also:
I_CmsTermHighlighter.getExcerpt(org.apache.lucene.document.Document, org.opencms.search.CmsSearchIndex, org.opencms.search.CmsSearchParameters, org.apache.lucene.search.Query, org.apache.lucene.analysis.Analyzer)
-
-