Namespace Lucene.Net.Search.Highlight

Simple IEncoder implementation that does not modify the output

Formats text with different color intensity depending on the score of the term.

Class used to markup highlighted terms found in the best sections of a text, using configurable IFragmenter, , IFormatter, IEncoder and tokenizers.

Exception thrown if TokenStream Tokens are incompatible with provided text

IFragmenter implementation which does not fragment the text. This is useful for highlighting the entire content of a document or field.

This limits the number of tokens while indexing by adding up the current offset.

Utility class to record Positions Spans @lucene.internal

IScorer implementation which scores text fragments by the number of unique query terms found. This class converts appropriate s to s and attempts to score only those terms that participated in generating the 'hit' on the document.

Utility class used to extract the terms used in a query, plus any weights. This class will not find terms for , RangeQuery and classes so the caller must pass a rewritten query (see ) to obtain a list of expanded terms.

IScorer implementation which scores text fragments by the number of unique query terms found. This class uses the QueryTermExtractor class to process determine the query terms and their boosts to be used.

IFragmenter implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries.

Simple IEncoder implementation to escape text for HTML output

Simple IFormatter implementation to highlight terms with a pre and post tag

IFragmenter implementation which breaks text up into same-size fragments but does not split up . This is a simple sample class.

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.

Low-level class used to record information about a section of a document with a score.

One, or several overlapping tokens, along with the score(s) and the scope of the original text

Hides implementation issues associated with obtaining a for use with the Highlighter - can obtain from term vectors with offsets and positions or from an Analyzer re-parsing the stored content. see TokenStreamFromTermVector

created from a term vector field.

Lightweight class to hold term, weight, and positions used for scoring this term.

Class used to extract WeightedSpanTerms from a based on whether s from the are contained in a supplied .

This class makes sure that if both position sensitive and insensitive versions of the same term are added, the position insensitive one wins.

Lightweight class to hold term and a Weight value used for scoring this term

Encodes original text. The IEncoder works with the IFormatter to generate the output.

Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.

Implements the policy for breaking text into multiple fragments for consideration by the Highlighter class. A sophisticated implementation may do this on the basis of detecting end of sentences in the text.

A IScorer is responsible for scoring a stream of tokens. These token scores can then be used to compute TextFragment scores.