org.apache.jackrabbit.core.query.lucene
Interface ExcerptProvider

All Known Implementing Classes:

SimpleExcerptProvider

public interface ExcerptProvider

ExcerptProvider defines an interface to get an XML excerpt of a matching node.
E.g. if you search for 'jackrabbit' and 'query' you may get the following result for a node:

 <excerpt>
     <fragment><highlight>Jackrabbit</highlight> implements both the mandatory XPath and optional SQL <highlight>query</highlight> syntax.</fragment>
     <fragment>Before parsing the XPath <highlight>query</highlight> in <highlight>Jackrabbit</highlight>, the statement is surrounded</fragment>
 </excerpt>
 

Field Summary

static QName

REP_EXCERPT QName of the rep:excerpt function.

Method Summary

String	getExcerpt(NodeId id, int maxFragments, int maxFragmentSize) Returns the XML excerpt for the node with id.
void	init(org.apache.lucene.search.Query query, SearchIndex index) Initializes this excerpt provider.

Field Detail

REP_EXCERPT

static final QName REP_EXCERPT

QName of the rep:excerpt function.

Method Detail

init

void init(org.apache.lucene.search.Query query,
          SearchIndex index)
          throws IOException

Initializes this excerpt provider.

Parameters:

query - excerpts will be based on this query.

index - provides access to the search index.

Throws:

IOException - if an error occurs while initializing this excerpt provider.

getExcerpt

String getExcerpt(NodeId id,
                  int maxFragments,
                  int maxFragmentSize)
                  throws IOException

Returns the XML excerpt for the node with id.

Parameters:

id - a node id.

maxFragments - the maximum number of fragments to create.

maxFragmentSize - the maximum number of characters in a fragment.

Returns:

the XML excerpt or null if there is no node with id.

Throws:

IOException - if an error occurs while creating the excerpt.