Class FieldHighlighter
- java.lang.Object
-
- org.apache.lucene.search.uhighlight.FieldHighlighter
-
public class FieldHighlighter extends java.lang.Object
Internal highlighter abstraction that operates on a per field basis.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.text.BreakIterator
breakIterator
protected java.lang.String
field
protected FieldOffsetStrategy
fieldOffsetStrategy
protected int
maxNoHighlightPassages
protected int
maxPassages
protected PassageFormatter
passageFormatter
protected PassageScorer
passageScorer
-
Constructor Summary
Constructors Constructor Description FieldHighlighter(java.lang.String field, FieldOffsetStrategy fieldOffsetStrategy, java.text.BreakIterator breakIterator, PassageScorer passageScorer, int maxPassages, int maxNoHighlightPassages, PassageFormatter passageFormatter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getField()
UnifiedHighlighter.OffsetSource
getOffsetSource()
protected Passage[]
getSummaryPassagesNoHighlight(int maxPassages)
Called to summarize a document when no highlights were found.java.lang.Object
highlightFieldForDoc(LeafReader reader, int docId, java.lang.String content)
The primary method -- highlight this doc, assuming a specific field and given this content.protected Passage[]
highlightOffsetsEnums(OffsetsEnum off)
private Passage
maybeAddPassage(java.util.PriorityQueue<Passage> passageQueue, PassageScorer scorer, Passage passage, int contentLength)
-
-
-
Field Detail
-
field
protected final java.lang.String field
-
fieldOffsetStrategy
protected final FieldOffsetStrategy fieldOffsetStrategy
-
breakIterator
protected final java.text.BreakIterator breakIterator
-
passageScorer
protected final PassageScorer passageScorer
-
maxPassages
protected final int maxPassages
-
maxNoHighlightPassages
protected final int maxNoHighlightPassages
-
passageFormatter
protected final PassageFormatter passageFormatter
-
-
Constructor Detail
-
FieldHighlighter
public FieldHighlighter(java.lang.String field, FieldOffsetStrategy fieldOffsetStrategy, java.text.BreakIterator breakIterator, PassageScorer passageScorer, int maxPassages, int maxNoHighlightPassages, PassageFormatter passageFormatter)
-
-
Method Detail
-
getField
public java.lang.String getField()
-
getOffsetSource
public UnifiedHighlighter.OffsetSource getOffsetSource()
-
highlightFieldForDoc
public java.lang.Object highlightFieldForDoc(LeafReader reader, int docId, java.lang.String content) throws java.io.IOException
The primary method -- highlight this doc, assuming a specific field and given this content.- Throws:
java.io.IOException
-
getSummaryPassagesNoHighlight
protected Passage[] getSummaryPassagesNoHighlight(int maxPassages)
Called to summarize a document when no highlights were found. By default this just returns the firstmaxPassages
sentences; subclasses can override to customize. The state ofbreakIterator
should be at the beginning.
-
highlightOffsetsEnums
protected Passage[] highlightOffsetsEnums(OffsetsEnum off) throws java.io.IOException
- Throws:
java.io.IOException
-
maybeAddPassage
private Passage maybeAddPassage(java.util.PriorityQueue<Passage> passageQueue, PassageScorer scorer, Passage passage, int contentLength)
-
-