info.magnolia.jackrabbit.lucene

Class SearchHTMLExcerpt

java.lang.Object

org.apache.jackrabbit.core.query.lucene.AbstractExcerpt

info.magnolia.jackrabbit.lucene.SearchHTMLExcerpt

All Implemented Interfaces:

org.apache.jackrabbit.core.query.lucene.ExcerptProvider, org.apache.jackrabbit.core.query.lucene.HighlightingExcerptProvider

public class SearchHTMLExcerpt
extends org.apache.jackrabbit.core.query.lucene.AbstractExcerpt

Provides an HTML excerpt highlighting the searched term. By default it will strip all HTML tags and jcr identifiers which might have been indexed. Suppose you were searching for "foo" and the text found containing it is something like

 <p>This is an "excerpt" <em>highlighting</em> the word foo deadbeef-face-babe-cafe-babecafebabe...
 

it produces a result like the following which can then be used e.g. in a search result page.

 <div class="excerpt">
  <span class="excerpt-fragment">This is an excerpt highlighting the word <strong>foo</strong>...</span>
 <div>

 

Field Summary

Fields inherited from class org.apache.jackrabbit.core.query.lucene.AbstractExcerpt

index, query

Fields inherited from interface org.apache.jackrabbit.core.query.lucene.ExcerptProvider

REP_EXCERPT

Constructor Summary

Constructors

Constructor and Description
SearchHTMLExcerpt()

Method Summary

Modifier and Type	Method and Description
protected String	createExcerpt(org.apache.lucene.index.TermPositionVector tpv, String text, int maxFragments, int maxFragmentSize)

Methods inherited from class org.apache.jackrabbit.core.query.lucene.AbstractExcerpt

getExcerpt, getQueryTerms, highlight, init

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchHTMLExcerpt

public SearchHTMLExcerpt()

Method Detail

createExcerpt

protected String createExcerpt(org.apache.lucene.index.TermPositionVector tpv,
                               String text,
                               int maxFragments,
                               int maxFragmentSize)
                        throws IOException

Specified by:

createExcerpt in class org.apache.jackrabbit.core.query.lucene.AbstractExcerpt

Throws:

IOException