Namespace Lucene.Net.Search.Highlight

Classes

DefaultEncoder

Simple IEncoder 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 IFragmenter, Scorer, IFormatter, IEncoder and tokenizers.

InvalidTokenOffsetsException

Exception thrown if TokenStream Tokens are incompatible with provided text

NullFragmenter

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

OffsetLimitTokenFilter

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

PositionSpan

Utility class to record Positions Spans

This is a Lucene.NET INTERNAL API, use at your own risk

QueryScorer

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

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 Rewrite(IndexReader)) to obtain a list of expanded terms.

QueryTermScorer

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.

SimpleFragmenter

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

SimpleHTMLEncoder

Simple IEncoder implementation to escape text for HTML output

SimpleHTMLFormatter

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

SimpleSpanFragmenter

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

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 Highlighter - can obtain from term vectors with offsets and positions or from an Analyzer re-parsing the stored content. see TokenStreamFromTermVector

TokenStreamFromTermPositionVector

TokenStream created from a term vector field.

WeightedSpanTerm

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

WeightedSpanTermExtractor

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

WeightedSpanTermExtractor.PositionCheckingMap<K>

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

WeightedTerm

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

Interfaces

IEncoder

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

IFormatter

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

IFragmenter

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.

IScorer

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