A D E F G H I M N O Q S T W

## A

allFragmentsProcessed() - Method in class org.apache.lucene.search.highlight.QueryScorer

## D

DEFAULT_MAX_DOC_BYTES_TO_ANALYZE - Static variable in class org.apache.lucene.search.highlight.Highlighter
DefaultEncoder - Class in org.apache.lucene.search.highlight
  Simple `Encoder` implementation that does not modify the output
DefaultEncoder() - Constructor for class org.apache.lucene.search.highlight.DefaultEncoder

## E

Encoder - Interface in org.apache.lucene.search.highlight
  Encodes original text.
encodeText(String) - Method in class org.apache.lucene.search.highlight.DefaultEncoder
encodeText(String) - Method in interface org.apache.lucene.search.highlight.Encoder
encodeText(String) - Method in class org.apache.lucene.search.highlight.SimpleHTMLEncoder

## F

follows(TextFragment) - Method in class org.apache.lucene.search.highlight.TextFragment
Formatter - Interface in org.apache.lucene.search.highlight
  Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.
Fragmenter - Interface in org.apache.lucene.search.highlight
  Implements the policy for breaking text into multiple fragments for consideration by the `Highlighter` class.

## G

getAnyTokenStream(IndexReader, int, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  A convenience method that tries a number of approaches to getting a token stream.
getBackgroundColorString(float) - Method in class org.apache.lucene.search.highlight.GradientFormatter
getBestFragment(Analyzer, String, String) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant section.
getBestFragment(TokenStream, String) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant section.
getBestFragments(Analyzer, String, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Deprecated. This method incorrectly hardcodes the choice of fieldname. Use the method of the same name that takes a fieldname.
getBestFragments(Analyzer, String, String, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant sections.
getBestFragments(TokenStream, String, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant sections.
getBestFragments(TokenStream, String, int, String) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights terms in the text , extracting the most relevant sections and concatenating the chosen fragments with a separator (typically "...").
getBestTextFragments(TokenStream, String, boolean, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Low level api to get the most relevant (formatted) sections of the document.
getEncoder() - Method in class org.apache.lucene.search.highlight.Highlighter
getEndOffset() - Method in class org.apache.lucene.search.highlight.TokenGroup
getForegroundColorString(float) - Method in class org.apache.lucene.search.highlight.GradientFormatter
getFragmentScore() - Method in class org.apache.lucene.search.highlight.QueryScorer
getFragmentScore() - Method in interface org.apache.lucene.search.highlight.Scorer
  Called when the highlighter has no more tokens for the current fragment - the scorer returns the weighting it has derived for the most recent fragment, typically based on the tokens passed to getTokenScore().
getFragmentScorer() - Method in class org.apache.lucene.search.highlight.Highlighter
getFragmentSize() - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
getFragNum() - Method in class org.apache.lucene.search.highlight.TextFragment
getIdfWeightedTerms(Query, IndexReader, String) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getMaxDocBytesToAnalyze() - Method in class org.apache.lucene.search.highlight.Highlighter
getMaxTermWeight() - Method in class org.apache.lucene.search.highlight.QueryScorer
getNumTokens() - Method in class org.apache.lucene.search.highlight.TokenGroup
getScore() - Method in class org.apache.lucene.search.highlight.TextFragment
getScore(int) - Method in class org.apache.lucene.search.highlight.TokenGroup
getStartOffset() - Method in class org.apache.lucene.search.highlight.TokenGroup
getTerm() - Method in class org.apache.lucene.search.highlight.WeightedTerm
getTerms(Query) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getTerms(Query, boolean, String) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getTerms(Query, boolean) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getTextFragmenter() - Method in class org.apache.lucene.search.highlight.Highlighter
getToken(int) - Method in class org.apache.lucene.search.highlight.TokenGroup
getTokenScore(Token) - Method in class org.apache.lucene.search.highlight.QueryScorer
getTokenScore(Token) - Method in interface org.apache.lucene.search.highlight.Scorer
  Called for each token in the current fragment
getTokenStream(TermPositionVector) - Static method in class org.apache.lucene.search.highlight.TokenSources
getTokenStream(TermPositionVector, boolean) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Low level api.
getTokenStream(IndexReader, int, String) - Static method in class org.apache.lucene.search.highlight.TokenSources
getTokenStream(IndexReader, int, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
getTotalScore() - Method in class org.apache.lucene.search.highlight.TokenGroup
getWeight() - Method in class org.apache.lucene.search.highlight.WeightedTerm
GradientFormatter - Class in org.apache.lucene.search.highlight
  Formats text with different color intensity depending on the score of the term.
GradientFormatter(float, String, String, String, String) - Constructor for class org.apache.lucene.search.highlight.GradientFormatter
  Sets the color range for the IDF scores

## H

hexToInt(String) - Static method in class org.apache.lucene.search.highlight.GradientFormatter
  Converts a hex string into an int.
highlightBackground - Variable in class org.apache.lucene.search.highlight.GradientFormatter
Highlighter - Class in org.apache.lucene.search.highlight
  Class used to markup highlighted terms found in the best sections of a text, using configurable `Fragmenter`, `Scorer`, `Formatter`, `Encoder` and tokenizers.
Highlighter(Scorer) - Constructor for class org.apache.lucene.search.highlight.Highlighter
Highlighter(Formatter, Scorer) - Constructor for class org.apache.lucene.search.highlight.Highlighter
Highlighter(Formatter, Encoder, Scorer) - Constructor for class org.apache.lucene.search.highlight.Highlighter
highlightForeground - Variable in class org.apache.lucene.search.highlight.GradientFormatter
highlightTerm(String, TokenGroup) - Method in interface org.apache.lucene.search.highlight.Formatter
highlightTerm(String, TokenGroup) - Method in class org.apache.lucene.search.highlight.GradientFormatter
highlightTerm(String, TokenGroup) - Method in class org.apache.lucene.search.highlight.SimpleHTMLFormatter
highlightTerm(String, TokenGroup) - Method in class org.apache.lucene.search.highlight.SpanGradientFormatter
htmlEncode(String) - Static method in class org.apache.lucene.search.highlight.SimpleHTMLEncoder
  Encode string into HTML

## I

isNewFragment(Token) - Method in interface org.apache.lucene.search.highlight.Fragmenter
  Test to see if this token from the stream should be held in a new TextFragment
isNewFragment(Token) - Method in class org.apache.lucene.search.highlight.NullFragmenter
isNewFragment(Token) - Method in class org.apache.lucene.search.highlight.SimpleFragmenter

## M

merge(TextFragment) - Method in class org.apache.lucene.search.highlight.TextFragment

## N

NullFragmenter - Class in org.apache.lucene.search.highlight
  `Fragmenter` implementation which does not fragment the text.
NullFragmenter() - Constructor for class org.apache.lucene.search.highlight.NullFragmenter

## O

org.apache.lucene.search.highlight - package org.apache.lucene.search.highlight
  The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.

## Q

QueryScorer - Class in org.apache.lucene.search.highlight
  `Scorer` implementation which scores text fragments by the number of unique query terms found.
QueryScorer(Query) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, IndexReader, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(WeightedTerm[]) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryTermExtractor - Class in org.apache.lucene.search.highlight
  Utility class used to extract the terms used in a query, plus any weights.
QueryTermExtractor() - Constructor for class org.apache.lucene.search.highlight.QueryTermExtractor

## S

Scorer - Interface in org.apache.lucene.search.highlight
  Adds to the score for a fragment based on its tokens
setEncoder(Encoder) - Method in class org.apache.lucene.search.highlight.Highlighter
setFragmentScorer(Scorer) - Method in class org.apache.lucene.search.highlight.Highlighter
setFragmentSize(int) - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
setMaxDocBytesToAnalyze(int) - Method in class org.apache.lucene.search.highlight.Highlighter
setTerm(String) - Method in class org.apache.lucene.search.highlight.WeightedTerm
setTextFragmenter(Fragmenter) - Method in class org.apache.lucene.search.highlight.Highlighter
setWeight(float) - Method in class org.apache.lucene.search.highlight.WeightedTerm
SimpleFragmenter - Class in org.apache.lucene.search.highlight
  `Fragmenter` implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries.
SimpleFragmenter() - Constructor for class org.apache.lucene.search.highlight.SimpleFragmenter
SimpleFragmenter(int) - Constructor for class org.apache.lucene.search.highlight.SimpleFragmenter
SimpleHTMLEncoder - Class in org.apache.lucene.search.highlight
  Simple `Encoder` implementation to escape text for HTML output
SimpleHTMLEncoder() - Constructor for class org.apache.lucene.search.highlight.SimpleHTMLEncoder
SimpleHTMLFormatter - Class in org.apache.lucene.search.highlight
  Simple `Formatter` implementation to highlight terms with a pre and post tag
SimpleHTMLFormatter(String, String) - Constructor for class org.apache.lucene.search.highlight.SimpleHTMLFormatter
SimpleHTMLFormatter() - Constructor for class org.apache.lucene.search.highlight.SimpleHTMLFormatter
  Default constructor uses HTML: <B> tags to markup terms
SpanGradientFormatter - Class in org.apache.lucene.search.highlight
  Formats text with different color intensity depending on the score of the term using the span tag.
SpanGradientFormatter(float, String, String, String, String) - Constructor for class org.apache.lucene.search.highlight.SpanGradientFormatter
start(String) - Method in interface org.apache.lucene.search.highlight.Fragmenter
  Initializes the Fragmenter
start(String) - Method in class org.apache.lucene.search.highlight.NullFragmenter
start(String) - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
startFragment(TextFragment) - Method in class org.apache.lucene.search.highlight.QueryScorer
startFragment(TextFragment) - Method in interface org.apache.lucene.search.highlight.Scorer
  called when a new fragment is started for consideration

## T

TextFragment - Class in org.apache.lucene.search.highlight
  Low-level class used to record information about a section of a document with a score.
TextFragment(StringBuffer, int, int) - Constructor for class org.apache.lucene.search.highlight.TextFragment
TokenGroup - Class in org.apache.lucene.search.highlight
  One, or several overlapping tokens, along with the score(s) and the scope of the original text
TokenGroup() - Constructor for class org.apache.lucene.search.highlight.TokenGroup
TokenSources - Class in org.apache.lucene.search.highlight
  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() - Constructor for class org.apache.lucene.search.highlight.TokenSources
toString() - Method in class org.apache.lucene.search.highlight.TextFragment

## W

WeightedTerm - Class in org.apache.lucene.search.highlight
  Lightweight class to hold term and a weight value used for scoring this term
WeightedTerm(float, String) - Constructor for class org.apache.lucene.search.highlight.WeightedTerm

A D E F G H I M N O Q S T W

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.