The Highlighter type exposes the following members.

Constructors

  NameDescription
Public methodHighlighter(Scorer)
Initializes a new instance of the Highlighter class
Public methodHighlighter(Formatter, Scorer)
Initializes a new instance of the Highlighter class
Public methodHighlighter(Formatter, Encoder, Scorer)
Initializes a new instance of the Highlighter class

Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBestFragment(TokenStream, String)
Highlights chosen terms in a text, extracting the most relevant section. The document text is analysed in chunks to record hit statistics across the document. After accumulating stats, the fragment with the highest score is returned
Public methodGetBestFragment(Analyzer, String, String)
Highlights chosen terms in a text, extracting the most relevant section. This is a convenience method that calls {@link #GetBestFragment(TokenStream, String)}
Public methodGetBestFragments(Analyzer, String, Int32)
Highlights chosen terms in a text, extracting the most relevant sections. This is a convenience method that calls {@link #getBestFragments(TokenStream, String, int)}
Public methodGetBestFragments(TokenStream, String, Int32)
Highlights chosen terms in a text, extracting the most relevant sections. The document text is analysed in chunks to record hit statistics across the document. After accumulating stats, the fragments with the highest scores are returned as an array of strings in order of score (contiguous fragments are merged into one in their original order to improve readability)
Public methodGetBestFragments(Analyzer, String, String, Int32)
Highlights chosen terms in a text, extracting the most relevant sections. This is a convenience method that calls {@link #getBestFragments(TokenStream, String, int)}
Public methodGetBestFragments(TokenStream, String, Int32, String)
Highlights terms in the text , extracting the most relevant sections and concatenating the chosen fragments with a separator (typically "..."). The document text is analysed in chunks to record hit statistics across the document. After accumulating stats, the fragments with the highest scores are returned in order as "separator" delimited strings.
Public methodGetBestTextFragments
Low level api to get the most relevant (formatted) sections of the document. This method has been made public to allow visibility of score information held in TextFragment objects. Thanks to Jason Calabrese for help in redefining the interface.
Public methodGetEncoder
Public methodGetFragmentScorer
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetMaxDocBytesToAnalyze
Public methodGetTextFragmenter
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetEncoder
Public methodSetFragmentScorer
Public methodSetMaxDocBytesToAnalyze
Public methodSetTextFragmenter
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

Fields

See Also