Package com.apple.foundationdb.record.lucene.highlight

Class SnippetFormatter

java.lang.Object

org.apache.lucene.search.uhighlight.PassageFormatter

com.apple.foundationdb.record.lucene.highlight.SnippetFormatter

@API(INTERNAL)
public class SnippetFormatter
extends org.apache.lucene.search.uhighlight.PassageFormatter

A PassageFormatter which keeps a whole number of words before and after matching text entries to provide context, and inserts ellipses in between matched strings to form a summarized text.

If you want a formatter which returns the whole string, use WholeTextFormatter instead.

Constructor Summary

Constructors

Constructor	Description
SnippetFormatter(String fieldName, Supplier<BreakIterator> breakIterator, int snippetSize)

Method Summary

Modifier and Type	Method	Description
Object	format(org.apache.lucene.search.uhighlight.Passage[] passages, String content)

Methods inherited from class java.lang.Object

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

Constructor Details

SnippetFormatter

public SnippetFormatter(String fieldName,
 Supplier<BreakIterator> breakIterator,
 int snippetSize)

Method Details

format

public Object format(org.apache.lucene.search.uhighlight.Passage[] passages,
 String content)

Specified by:

format in class org.apache.lucene.search.uhighlight.PassageFormatter