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

## A

addPositionSpans(List) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
allFragmentsProcessed() - Method in class org.apache.lucene.search.highlight.QueryTermScorer

## C

checkPosition(int) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
  Checks to see if this term is valid at `position`.

## D

DEFAULT_MAX_CHARS_TO_ANALYZE - Static variable in class org.apache.lucene.search.highlight.Highlighter
DEFAULT_MAX_DOC_BYTES_TO_ANALYZE - Static variable in class org.apache.lucene.search.highlight.Highlighter
  Deprecated. See `Highlighter.DEFAULT_MAX_CHARS_TO_ANALYZE`
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, Document, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  A convenience method that tries to first get a TermPositionVector for the specified docId, then, falls back to using the passed in `Document` to retrieve the TokenStream.
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
getExpandMultiTermQuery() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
getForegroundColorString(float) - Method in class org.apache.lucene.search.highlight.GradientFormatter
getFragmentScore() - Method in class org.apache.lucene.search.highlight.QueryScorer
getFragmentScore() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
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 results of `Scorer.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
  Deprecated. See `Highlighter.getMaxDocCharsToAnalyze()`, since this value has always counted on chars. They both set the same internal value, however
getMaxDocCharsToAnalyze() - Method in class org.apache.lucene.search.highlight.Highlighter
getMaxTermWeight() - Method in class org.apache.lucene.search.highlight.QueryScorer
getMaxTermWeight() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
getNumTokens() - Method in class org.apache.lucene.search.highlight.TokenGroup
getPositionSpans() - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
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() - Method in class org.apache.lucene.search.highlight.QueryScorer
getTokenScore() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
getTokenScore() - 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
getTokenStream(Document, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
getTokenStream(String, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
getTokenStream() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
getTotalScore() - Method in class org.apache.lucene.search.highlight.TokenGroup
getWeight() - Method in class org.apache.lucene.search.highlight.WeightedTerm
getWeightedSpanTerm(String) - Method in class org.apache.lucene.search.highlight.QueryScorer
  Retrieve the `WeightedSpanTerm` for the specified token.
getWeightedSpanTerms(Query, TokenStream) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.
getWeightedSpanTerms(Query, TokenStream, String) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.
getWeightedSpanTermsWithScores(Query, TokenStream, String, IndexReader) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.
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

init(TokenStream) - Method in class org.apache.lucene.search.highlight.QueryScorer
init(TokenStream) - Method in class org.apache.lucene.search.highlight.QueryTermScorer
init(TokenStream) - Method in interface org.apache.lucene.search.highlight.Scorer
  Called to init the Scorer with a `TokenStream`.
InvalidTokenOffsetsException - Exception in org.apache.lucene.search.highlight
  Exception thrown if TokenStream Tokens are incompatible with provided text
InvalidTokenOffsetsException(String) - Constructor for exception org.apache.lucene.search.highlight.InvalidTokenOffsetsException
isCachedTokenStream() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
isExpandMultiTermQuery() - Method in class org.apache.lucene.search.highlight.QueryScorer
isNewFragment() - 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() - Method in class org.apache.lucene.search.highlight.NullFragmenter
isNewFragment() - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
isNewFragment() - Method in class org.apache.lucene.search.highlight.SimpleSpanFragmenter
isPositionSensitive() - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm

## 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(Query, IndexReader, String, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, String, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(WeightedSpanTerm[]) - 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
QueryTermScorer - Class in org.apache.lucene.search.highlight
  `Scorer` implementation which scores text fragments by the number of unique query terms found.
QueryTermScorer(Query) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer
QueryTermScorer(Query, String) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer
QueryTermScorer(Query, IndexReader, String) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer
QueryTermScorer(WeightedTerm[]) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer

## S

Scorer - Interface in org.apache.lucene.search.highlight
  A Scorer is responsible for scoring a stream of tokens.
setEncoder(Encoder) - Method in class org.apache.lucene.search.highlight.Highlighter
setExpandMultiTermQuery(boolean) - Method in class org.apache.lucene.search.highlight.QueryScorer
  Controls whether or not multi-term queries are expanded against a `MemoryIndex` `IndexReader`.
setExpandMultiTermQuery(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
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
  Deprecated. See `Highlighter.setMaxDocCharsToAnalyze(int)`, since this value has always counted chars
setMaxDocCharsToAnalyze(int) - Method in class org.apache.lucene.search.highlight.Highlighter
setPositionSensitive(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
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
setWrapIfNotCachingTokenFilter(boolean) - Method in class org.apache.lucene.search.highlight.QueryScorer
  By default, `TokenStream`s that are not of the type `CachingTokenFilter` are wrapped in a `CachingTokenFilter` to ensure an efficient reset - if you are already using a different caching `TokenStream` impl and you don't want it to be wrapped, set this to false.
setWrapIfNotCachingTokenFilter(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  By default, `TokenStream`s that are not of the type `CachingTokenFilter` are wrapped in a `CachingTokenFilter` to ensure an efficient reset - if you are already using a different caching `TokenStream` impl and you don't want it to be wrapped, set this to false.
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.
SimpleSpanFragmenter - Class in org.apache.lucene.search.highlight
  `Fragmenter` implementation which breaks text up into same-size fragments but does not split up `Spans`.
SimpleSpanFragmenter(QueryScorer) - Constructor for class org.apache.lucene.search.highlight.SimpleSpanFragmenter
SimpleSpanFragmenter(QueryScorer, int) - Constructor for class org.apache.lucene.search.highlight.SimpleSpanFragmenter
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, TokenStream) - Method in interface org.apache.lucene.search.highlight.Fragmenter
  Initializes the Fragmenter.
start(String, TokenStream) - Method in class org.apache.lucene.search.highlight.NullFragmenter
start(String, TokenStream) - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
start(String, TokenStream) - Method in class org.apache.lucene.search.highlight.SimpleSpanFragmenter
startFragment(TextFragment) - Method in class org.apache.lucene.search.highlight.QueryScorer
startFragment(TextFragment) - Method in class org.apache.lucene.search.highlight.QueryTermScorer
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(TokenStream) - 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

WeightedSpanTerm - Class in org.apache.lucene.search.highlight
  Lightweight class to hold term, weight, and positions used for scoring this term.
WeightedSpanTerm(float, String) - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTerm
WeightedSpanTerm(float, String, boolean) - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTerm
WeightedSpanTermExtractor - Class in org.apache.lucene.search.highlight
  Class used to extract `WeightedSpanTerm`s from a `Query` based on whether `Term`s from the `Query` are contained in a supplied `TokenStream`.
WeightedSpanTermExtractor() - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
WeightedSpanTermExtractor(String) - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
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 C D E F G H I M N O Q S T W

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