The Highlighter type exposes the following members.
Constructors
Name | Description | |
---|---|---|
Highlighter(Scorer) | Initializes a new instance of the Highlighter class | |
Highlighter(Formatter, Scorer) | Initializes a new instance of the Highlighter class | |
Highlighter(Formatter, Encoder, Scorer) | Initializes a new instance of the Highlighter class |
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetBestFragment(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
| |
GetBestFragment(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)}
| |
GetBestFragments(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)}
| |
GetBestFragments(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)
| |
GetBestFragments(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)}
| |
GetBestFragments(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.
| |
GetBestTextFragments | 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.
| |
GetEncoder | ||
GetFragmentScorer | ||
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetMaxDocBytesToAnalyze | ||
GetTextFragmenter | ||
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetEncoder | ||
SetFragmentScorer | ||
SetMaxDocBytesToAnalyze | ||
SetTextFragmenter | ||
ToString | (Inherited from Object.) |
Fields
Name | Description | |
---|---|---|
DEFAULT_MAX_DOC_BYTES_TO_ANALYZE |