Class FieldHighlighter


  • public class FieldHighlighter
    extends java.lang.Object
    Internal highlighter abstraction that operates on a per field basis.
    • Field Detail

      • field

        protected final java.lang.String field
      • breakIterator

        protected final java.text.BreakIterator breakIterator
      • maxPassages

        protected final int maxPassages
      • maxNoHighlightPassages

        protected final int maxNoHighlightPassages
    • 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()
      • 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 first maxPassages sentences; subclasses can override to customize. The state of breakIterator should be at the beginning.
      • highlightOffsetsEnums

        protected Passage[] highlightOffsetsEnums​(OffsetsEnum off)
                                           throws java.io.IOException
        Throws:
        java.io.IOException