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

A

add(int, int, List<FieldPhraseList.WeightedPhraseInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList

convert the list of WeightedPhraseInfo to WeightedFragInfo, then add it to the fragInfos

addPositionSpans(List<PositionSpan>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm

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

B

BaseFragmentsBuilder - Class in org.apache.lucene.search.vectorhighlight

BaseFragmentsBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

BaseFragmentsBuilder(String[], String[]) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

BaseFragmentsBuilder(BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

BaseFragmentsBuilder(String[], String[], BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

boundaryChars - Variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

BoundaryScanner - Interface in org.apache.lucene.search.vectorhighlight

BreakIteratorBoundaryScanner - Class in org.apache.lucene.search.vectorhighlight

A BoundaryScanner implementation that uses BreakIterator to find boundaries in the text.

BreakIteratorBoundaryScanner(BreakIterator) - Constructor for class org.apache.lucene.search.vectorhighlight.BreakIteratorBoundaryScanner

C

checkPosition(int) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm

Checks to see if this term is valid at position.

collectSpanQueryFields(SpanQuery, Set<String>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

COLORED_POST_TAGS - Static variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

COLORED_PRE_TAGS - Static variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

compare(FieldFragList.WeightedFragInfo, FieldFragList.WeightedFragInfo) - Method in class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder.ScoreComparator

compareTo(FieldTermStack.TermInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

createFieldFragList(FieldPhraseList, int) - Method in interface org.apache.lucene.search.vectorhighlight.FragListBuilder

create a FieldFragList.

createFieldFragList(FieldPhraseList, int) - Method in class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder

createFieldFragList(FieldPhraseList, int) - Method in class org.apache.lucene.search.vectorhighlight.SingleFragListBuilder

createFragment(IndexReader, int, String, FieldFragList) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

createFragment(IndexReader, int, String, FieldFragList, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

createFragment(IndexReader, int, String, FieldFragList) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder

create a fragment.

createFragment(IndexReader, int, String, FieldFragList, String[], String[], Encoder) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder

create a fragment.

createFragments(IndexReader, int, String, FieldFragList, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

createFragments(IndexReader, int, String, FieldFragList, int, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

createFragments(IndexReader, int, String, FieldFragList, int) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder

create multiple fragments.

createFragments(IndexReader, int, String, FieldFragList, int, String[], String[], Encoder) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder

create multiple fragments.

D

DEFAULT_BOUNDARY_CHARS - Static variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

DEFAULT_FIELD_MATCH - Static variable in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

DEFAULT_MAX_CHARS_TO_ANALYZE - Static variable in class org.apache.lucene.search.highlight.Highlighter

DEFAULT_MAX_SCAN - Static variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

DEFAULT_PHRASE_HIGHLIGHT - Static variable in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

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

extract(Query, Map<String, WeightedSpanTerm>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

Fills a Map with <@link WeightedSpanTerm>s using the terms from the supplied Query.

extractUnknownQuery(Query, Map<String, WeightedSpanTerm>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

extractWeightedSpanTerms(Map<String, WeightedSpanTerm>, SpanQuery) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

Fills a Map with <@link WeightedSpanTerm>s using the terms from the supplied SpanQuery.

extractWeightedTerms(Map<String, WeightedSpanTerm>, Query) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

Fills a Map with <@link WeightedSpanTerm>s using the terms from the supplied Query.

F

FastVectorHighlighter - Class in org.apache.lucene.search.vectorhighlight

Another highlighter implementation.

FastVectorHighlighter() - Constructor for class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

the default constructor.

FastVectorHighlighter(boolean, boolean) - Constructor for class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

a constructor.

FastVectorHighlighter(boolean, boolean, FragListBuilder, FragmentsBuilder) - Constructor for class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

a constructor.

FieldFragList - Class in org.apache.lucene.search.vectorhighlight

FieldFragList has a list of "frag info" that is used by FragmentsBuilder class to create fragments (snippets).

FieldFragList(int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldFragList

a constructor.

FieldFragList.WeightedFragInfo - Class in org.apache.lucene.search.vectorhighlight

FieldFragList.WeightedFragInfo(int, int, List<FieldPhraseList.WeightedPhraseInfo>) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo

FieldFragList.WeightedFragInfo.SubInfo - Class in org.apache.lucene.search.vectorhighlight

fieldNameComparator(String) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

Necessary to implement matches for queries against defaultField

FieldPhraseList - Class in org.apache.lucene.search.vectorhighlight

FieldPhraseList has a list of WeightedPhraseInfo that is used by FragListBuilder to create a FieldFragList object.

FieldPhraseList(FieldTermStack, FieldQuery) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList

create a FieldPhraseList that has no limit on the number of phrases to analyze

FieldPhraseList(FieldTermStack, FieldQuery, int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList

a constructor.

FieldPhraseList.WeightedPhraseInfo - Class in org.apache.lucene.search.vectorhighlight

FieldPhraseList.WeightedPhraseInfo(LinkedList<FieldTermStack.TermInfo>, float) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo

FieldPhraseList.WeightedPhraseInfo(LinkedList<FieldTermStack.TermInfo>, float, int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo

FieldPhraseList.WeightedPhraseInfo.Toffs - Class in org.apache.lucene.search.vectorhighlight

FieldPhraseList.WeightedPhraseInfo.Toffs(int, int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs

FieldQuery - Class in org.apache.lucene.search.vectorhighlight

FieldQuery breaks down query object into terms/phrases and keep them in QueryPhraseMap structure.

FieldQuery.QueryPhraseMap - Class in org.apache.lucene.search.vectorhighlight

FieldQuery.QueryPhraseMap(FieldQuery) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

FieldTermStack - Class in org.apache.lucene.search.vectorhighlight

FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlighted.

FieldTermStack(IndexReader, int, String, FieldQuery) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldTermStack

a constructor.

FieldTermStack.TermInfo - Class in org.apache.lucene.search.vectorhighlight

findEndOffset(StringBuilder, int) - Method in interface org.apache.lucene.search.vectorhighlight.BoundaryScanner

Scan forward to find start offset.

findEndOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.BreakIteratorBoundaryScanner

findEndOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

findStartOffset(StringBuilder, int) - Method in interface org.apache.lucene.search.vectorhighlight.BoundaryScanner

Scan backward to find end offset.

findStartOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.BreakIteratorBoundaryScanner

findStartOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

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.

FragListBuilder - Interface in org.apache.lucene.search.vectorhighlight

FragListBuilder is an interface for FieldFragList builder classes.

Fragmenter - Interface in org.apache.lucene.search.highlight

Implements the policy for breaking text into multiple fragments for consideration by the Highlighter class.

FragmentsBuilder - Interface in org.apache.lucene.search.vectorhighlight

FragmentsBuilder is an interface for fragments (snippets) builder classes.

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.

getBestFragment(FieldQuery, IndexReader, int, String, int) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

return the best fragment.

getBestFragment(FieldQuery, IndexReader, int, String, int, FragListBuilder, FragmentsBuilder, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

return the best fragment.

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 "...").

getBestFragments(FieldQuery, IndexReader, int, String, int, int) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

return the best fragments.

getBestFragments(FieldQuery, IndexReader, int, String, int, int, FragListBuilder, FragmentsBuilder, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

return the best fragments.

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.

getBoost() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

getEncoder() - Method in class org.apache.lucene.search.highlight.Highlighter

getEndOffset() - Method in class org.apache.lucene.search.highlight.TokenGroup

getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo

getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo

getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs

getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

getExpandMultiTermQuery() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

getFieldName() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack

getFieldQuery(Query) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

create a FieldQuery object.

getFieldQuery(Query, IndexReader) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

create a FieldQuery object.

getFields(IndexReader, int, String) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getFieldTermMap(String, String) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery

getFieldValues(IndexReader, int, String) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

Deprecated.

getForegroundColorString(float) - Method in class org.apache.lucene.search.highlight.GradientFormatter

getFragInfos() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList

return the list of WeightedFragInfos.

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

getFragmentSource(StringBuilder, int[], String[], int, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

Deprecated.

getFragmentSource(StringBuilder, int[], Field[], int, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getFragmentSourceMSO(StringBuilder, int[], Field[], int, int, int[]) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

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

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

getMultiValuedSeparator() - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getNumTokens() - Method in class org.apache.lucene.search.highlight.TokenGroup

getPhraseLimit() - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

getPosition() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

getPositionSpans() - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm

getPostTag(int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getPostTag(String[], int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getPreTag(int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getPreTag(String[], int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getReaderForField(String) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

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

getScore(int) - Method in class org.apache.lucene.search.highlight.TokenGroup

getSeqnum() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo

getSlop() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

getStartOffset() - Method in class org.apache.lucene.search.highlight.TokenGroup

getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo

getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo

getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs

getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

getSubInfos() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo

getTerm() - Method in class org.apache.lucene.search.highlight.WeightedTerm

getTermMap(String) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

getTermOrPhraseNumber() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

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

getTermsOffsets() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo

getText() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

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

getTotalBoost() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo

getTotalScore() - Method in class org.apache.lucene.search.highlight.TokenGroup

getWeight() - Method in class org.apache.lucene.search.highlight.WeightedTerm

getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo>) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo>) - Method in class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder

Sort by score the list of WeightedFragInfo

getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo>) - Method in class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder

do nothing.

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

incrementToken() - Method in class org.apache.lucene.search.highlight.OffsetLimitTokenFilter

incrementToken() - Method in class org.apache.lucene.search.highlight.TokenStreamFromTermPositionVector

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

isEmpty() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack

to know whether the stack is empty

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

isFieldMatch() - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

return whether fieldMatch or not.

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

isOffsetOverlap(FieldPhraseList.WeightedPhraseInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo

isPhraseHighlight() - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

return whether phraseHighlight or not.

isPositionSensitive() - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm

isTerminal() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

isValidTermOrPhrase(List<FieldTermStack.TermInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

M

main(String[]) - Static method in class org.apache.lucene.search.vectorhighlight.FieldTermStack

makeFragment(StringBuilder, int[], String[], FieldFragList.WeightedFragInfo) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

Deprecated.

makeFragment(StringBuilder, int[], Field[], FieldFragList.WeightedFragInfo, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

MARGIN_DEFAULT - Static variable in class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder

maxScan - Variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

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

MIN_FRAG_CHAR_SIZE_FACTOR - Static variable in class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder

mustRewriteQuery(SpanQuery) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

N

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

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

OffsetLimitTokenFilter - Class in org.apache.lucene.search.highlight

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

OffsetLimitTokenFilter(TokenStream, int) - Constructor for class org.apache.lucene.search.highlight.OffsetLimitTokenFilter

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.

org.apache.lucene.search.vectorhighlight - package org.apache.lucene.search.vectorhighlight

This is an another highlighter implementation.

P

pop() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack

PositionSpan - Class in org.apache.lucene.search.highlight

Utility class to record Positions Spans

PositionSpan(int, int) - Constructor for class org.apache.lucene.search.highlight.PositionSpan

postTags - Variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

preTags - Variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

push(FieldTermStack.TermInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack

put(K, WeightedSpanTerm) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor.PositionCheckingMap

putAll(Map<? extends K, ? extends WeightedSpanTerm>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor.PositionCheckingMap

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

R

reset() - Method in class org.apache.lucene.search.highlight.OffsetLimitTokenFilter

reset() - Method in class org.apache.lucene.search.highlight.TokenStreamFromTermPositionVector

S

ScoreOrderFragmentsBuilder - Class in org.apache.lucene.search.vectorhighlight

An implementation of FragmentsBuilder that outputs score-order fragments.

ScoreOrderFragmentsBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder

a constructor.

ScoreOrderFragmentsBuilder(String[], String[]) - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder

a constructor.

ScoreOrderFragmentsBuilder(BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder

ScoreOrderFragmentsBuilder(String[], String[], BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder

ScoreOrderFragmentsBuilder.ScoreComparator - Class in org.apache.lucene.search.vectorhighlight

ScoreOrderFragmentsBuilder.ScoreComparator() - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder.ScoreComparator

Scorer - Interface in org.apache.lucene.search.highlight

A Scorer is responsible for scoring a stream of tokens.

searchPhrase(List<FieldTermStack.TermInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

searchPhrase(String, List<FieldTermStack.TermInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery

setEncoder(Encoder) - Method in class org.apache.lucene.search.highlight.Highlighter

setEndOffset(int) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs

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

setMaxDocCharsToAnalyze(int) - Method in class org.apache.lucene.search.highlight.Highlighter

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

setMaxDocCharsToAnalyze(int) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

setMultiValuedSeparator(char) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

setPhraseLimit(int) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter

set the maximum number of phrases to analyze when searching for the highest-scoring phrase.

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, TokenStreams 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, TokenStreams 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.

SimpleBoundaryScanner - Class in org.apache.lucene.search.vectorhighlight

SimpleBoundaryScanner() - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

SimpleBoundaryScanner(int) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

SimpleBoundaryScanner(Character[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

SimpleBoundaryScanner(int, Character[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

SimpleBoundaryScanner(int, Set<Character>) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner

SimpleFragListBuilder - Class in org.apache.lucene.search.vectorhighlight

A simple implementation of FragListBuilder.

SimpleFragListBuilder(int) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder

SimpleFragListBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder

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

SimpleFragmentsBuilder - Class in org.apache.lucene.search.vectorhighlight

A simple implementation of FragmentsBuilder.

SimpleFragmentsBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder

a constructor.

SimpleFragmentsBuilder(String[], String[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder

a constructor.

SimpleFragmentsBuilder(BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder

SimpleFragmentsBuilder(String[], String[], BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder

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

SingleFragListBuilder - Class in org.apache.lucene.search.vectorhighlight

An implementation class of FragListBuilder that generates one FieldFragList.WeightedFragInfo object.

SingleFragListBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.SingleFragListBuilder

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(CharSequence, int, int) - Constructor for class org.apache.lucene.search.highlight.TextFragment

TextFragment(StringBuffer, int, int) - Constructor for class org.apache.lucene.search.highlight.TextFragment

Deprecated.

Use TextFragment.TextFragment(CharSequence, int, int) instead. This constructor will be removed in Lucene 4.0

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

TokenStreamFromTermPositionVector - Class in org.apache.lucene.search.highlight

TokenStreamFromTermPositionVector(TermPositionVector) - Constructor for class org.apache.lucene.search.highlight.TokenStreamFromTermPositionVector

Constructor.

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

toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo

toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo

toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs

toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo

toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

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 WeightedSpanTerms from a Query based on whether Terms 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

WeightedSpanTermExtractor.PositionCheckingMap<K> - Class in org.apache.lucene.search.highlight

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

WeightedSpanTermExtractor.PositionCheckingMap() - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTermExtractor.PositionCheckingMap

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 B C D E F G H I M N O P Q R S T W