All Classes (Lucene 3.6.2 API)

All Classes Interface Summary Class Summary Exception Summary
Class	Description
BaseFragmentsBuilder
BoundaryScanner
BreakIteratorBoundaryScanner	A `BoundaryScanner` implementation that uses `BreakIterator` to find boundaries in the text.
DefaultEncoder	Simple `Encoder` implementation that does not modify the output
Encoder	Encodes original text.
FastVectorHighlighter	Another highlighter implementation.
FieldFragList	FieldFragList has a list of "frag info" that is used by FragmentsBuilder class to create fragments (snippets).
FieldFragList.WeightedFragInfo
FieldFragList.WeightedFragInfo.SubInfo
FieldPhraseList	FieldPhraseList has a list of WeightedPhraseInfo that is used by FragListBuilder to create a FieldFragList object.
FieldPhraseList.WeightedPhraseInfo
FieldPhraseList.WeightedPhraseInfo.Toffs
FieldQuery	FieldQuery breaks down query object into terms/phrases and keep them in QueryPhraseMap structure.
FieldQuery.QueryPhraseMap
FieldTermStack	`FieldTermStack` is a stack that keeps query terms in the specified field of the document to be highlighted.
FieldTermStack.TermInfo
Formatter	Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.
FragListBuilder	FragListBuilder is an interface for FieldFragList builder classes.
Fragmenter	Implements the policy for breaking text into multiple fragments for consideration by the `Highlighter` class.
FragmentsBuilder	`FragmentsBuilder` is an interface for fragments (snippets) builder classes.
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 `Fragmenter`, `Scorer`, `Formatter`, `Encoder` and tokenizers.
InvalidTokenOffsetsException	Exception thrown if TokenStream Tokens are incompatible with provided text
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.
QueryTermExtractor	Utility class used to extract the terms used in a query, plus any weights.
QueryTermScorer	`Scorer` implementation which scores text fragments by the number of unique query terms found.
ScoreOrderFragmentsBuilder	An implementation of FragmentsBuilder that outputs score-order fragments.
ScoreOrderFragmentsBuilder.ScoreComparator
Scorer	A Scorer is responsible for scoring a stream of tokens.
SimpleBoundaryScanner
SimpleFragListBuilder	A simple implementation of `FragListBuilder`.
SimpleFragmenter	`Fragmenter` implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries.
SimpleFragmentsBuilder	A simple implementation of FragmentsBuilder.
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`.
SingleFragListBuilder	An implementation class of `FragListBuilder` that generates one `FieldFragList.WeightedFragInfo` object.
SpanGradientFormatter	Formats text with different color intensity depending on the score of the term using the span tag.
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.
TokenStreamFromTermPositionVector
WeightedSpanTerm	Lightweight class to hold term, weight, and positions used for scoring this term.
WeightedSpanTermExtractor	Class used to extract `WeightedSpanTerm`s from a `Query` based on whether `Term`s 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