Lucene.Net.Highlight Namespace
Namespace hierarchy
Classes
| Class |
Description |
|
DefaultEncoder
|
Simple {@link Encoder} implementation that does not modify the output |
|
GradientFormatter
|
Formats text with different color intensity depending on the score of the term. |
|
Highlighter
|
Class used to markup highlighted terms found in the best sections of a text, using configurable {@link Fragmenter}, {@link Scorer}, {@link Formatter}, {@link Encoder} and tokenizers. |
|
NullFragmenter
|
{@link Fragmenter} implementation which does not fragment the text. This is useful for highlighting the entire content of a document or field. |
|
QueryScorer
|
{@link Scorer} implementation which scores text fragments by the number of unique query terms found. This class uses the {@link QueryTermExtractor} class to process determine the query terms and their boosts to be used. |
|
QueryTermExtractor
|
Utility class used to extract the terms used in a query, plus any weights. This class will not find terms for MultiTermQuery, RangeQuery and PrefixQuery classes so the caller must pass a rewritten query (see Query.rewrite) to obtain a list of expanded terms. |
|
SimpleFragmenter
|
{@link Fragmenter} implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries. |
|
SimpleHTMLEncoder
|
Simple {@link Encoder} implementation to escape text for HTML output |
|
SimpleHTMLFormatter
|
Simple {@link Formatter} implementation to highlight terms with a pre and post tag |
|
SpanGradientFormatter
|
Formats text with different color intensity depending on the score of the term using the span tag. GradientFormatter uses a bgcolor argument to the font tag which doesn't work in Mozilla, thus this class. |
|
TextFragment
|
Low-level class used to record information about a section of a document with a score. |
|
TokenGroup
|
One, or several overlapping tokens, along with the score(s) and the scope of the original text |
|
TokenSources
|
Hides implementation issues associated with obtaining a TokenStream for use with the higlighter - can obtain from TermFreqVectors with offsets and (optionally) positions or from Analyzer class reparsing the stored content. |
|
TokenSources.StoredTokenStream
|
|
|
WeightedTerm
|
Lightweight class to hold term and a weight value used for scoring this term |
Interfaces
| Interface |
Description |
|
Encoder
|
Encodes original text. The Encoder works with the Formatter to generate the output. |
|
Formatter
|
Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages. |
|
Fragmenter
|
Implements the policy for breaking text into multiple fragments for consideration by the {@link Highlighter} class. A sophisticated implementation may do this on the basis of detecting end of sentences in the text. |
|
Scorer
|
Adds to the score for a fragment based on its tokens |