Package org.apache.lucene.search.highlight

Class SimpleHTMLFormatter

  • All Implemented Interfaces:
    Formatter
    public class SimpleHTMLFormatter
extends java.lang.Object
implements Formatter
    Simple Formatter implementation to highlight terms with a pre and post tag.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String DEFAULT_POST_TAG  
      private static java.lang.String DEFAULT_PRE_TAG  
      private java.lang.String postTag  
      private java.lang.String preTag  

    • Constructor Summary

      Constructors 
      Constructor Description
      SimpleHTMLFormatter()
      Default constructor uses HTML: <B> tags to markup terms.
      SimpleHTMLFormatter​(java.lang.String preTag, java.lang.String postTag)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String highlightTerm​(java.lang.String originalText, TokenGroup tokenGroup)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_POST_TAG

        private static final java.lang.String DEFAULT_POST_TAG
        See Also:
        Constant Field Values

      • preTag

        private java.lang.String preTag

      • postTag

        private java.lang.String postTag

    • Constructor Detail

      • SimpleHTMLFormatter

        public SimpleHTMLFormatter​(java.lang.String preTag,
                           java.lang.String postTag)

      • SimpleHTMLFormatter

        public SimpleHTMLFormatter()
        Default constructor uses HTML: <B> tags to markup terms.

    • Method Detail

      • highlightTerm

        public java.lang.String highlightTerm​(java.lang.String originalText,
                                      TokenGroup tokenGroup)
        Specified by:
        highlightTerm in interface Formatter
        Parameters:
        originalText - The section of text being considered for markup
        tokenGroup - contains one or several overlapping Tokens along with their scores and positions.