Package org.apache.lucene.search.highlight

Interface Summary

Interface	Description
Encoder	Encodes original text.
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 Highlighter class.
Scorer	A Scorer is responsible for scoring a stream of tokens.

Class Summary

Class	Description
DefaultEncoder	Simple Encoder implementation that does not modify the output
Highlighter	Marks up highlighted terms found in the best sections of text, using configurable Fragmenter, Scorer, Formatter, Encoder and tokenizers.
NullFragmenter	Fragmenter implementation which does not fragment the text.
OffsetLimitTokenFilter	This TokenFilter limits the number of tokens while indexing by adding up the current offset.
PositionSpan	Utility class to record Positions Spans
QueryScorer	Scorer implementation which scores text fragments by the number of unique query terms found.
SimpleFragmenter	Fragmenter implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries.
SimpleHTMLEncoder	Simple Encoder implementation to escape text for HTML output
SimpleHTMLFormatter	Simple Formatter implementation to highlight terms with a pre and post tag.
SimpleSpanFragmenter	Fragmenter implementation which breaks text up into same-size fragments but does not split up Spans.
TermVectorLeafReader	Wraps a Terms with a LeafReader, typically from term vectors.
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.
TokenStreamFromTermVector	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

Exception Summary

Exception	Description
InvalidTokenOffsetsException	Exception thrown if TokenStream Tokens are incompatible with provided text