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

Class HighlightedTerm

java.lang.Object

com.apple.foundationdb.record.lucene.highlight.HighlightedTerm

@API(EXPERIMENTAL)
public class HighlightedTerm
extends Object

Representation of a Single pass of a highlighter. This holds a summarized text (text which has been shortened with ellipses between highlight positions), along with a collection of intervals which are used to locate the specific locations to be highlighted.

Constructor Summary

Constructors

Constructor	Description
HighlightedTerm(String fieldName, String summarizedText, int[] highlightStarts, int[] highlightEnds)

Method Summary

Modifier and Type	Method	Description
String	getFieldName()
int	getHighlightEnd(int pos)
int	getHighlightStart(int pos)
int	getNumHighlights()
String	getSummarizedText()

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightedTerm

public HighlightedTerm(String fieldName,
 String summarizedText,
 int[] highlightStarts,
 int[] highlightEnds)

Method Details

getFieldName

public String getFieldName()

getSummarizedText

public String getSummarizedText()

getNumHighlights

public int getNumHighlights()

getHighlightStart

public int getHighlightStart(int pos)

getHighlightEnd

public int getHighlightEnd(int pos)