org.apache.lucene.search.uhighlight

Class MemoryIndexOffsetStrategy

java.lang.Object

org.apache.lucene.search.uhighlight.FieldOffsetStrategy

org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy

org.apache.lucene.search.uhighlight.MemoryIndexOffsetStrategy

public class MemoryIndexOffsetStrategy
extends AnalysisOffsetStrategy

Uses an Analyzer on content to get offsets and then populates a MemoryIndex.

Field Summary

Fields

Modifier and Type	Field and Description
private LeafReader	leafReader
private MemoryIndex	memoryIndex
private CharacterRunAutomaton	preMemIndexFilterAutomaton

Fields inherited from class org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy

analyzer

Fields inherited from class org.apache.lucene.search.uhighlight.FieldOffsetStrategy

automata, field, phraseHelper, terms

Constructor Summary

Constructors

Constructor and Description
MemoryIndexOffsetStrategy(java.lang.String field, java.util.function.Predicate<java.lang.String> fieldMatcher, BytesRef[] extractedTerms, PhraseHelper phraseHelper, CharacterRunAutomaton[] automata, Analyzer analyzer, java.util.function.Function<Query,java.util.Collection<Query>> multiTermQueryRewrite)

Method Summary

Modifier and Type	Method and Description
private static CharacterRunAutomaton	buildCombinedAutomaton(java.util.function.Predicate<java.lang.String> fieldMatcher, BytesRef[] terms, CharacterRunAutomaton[] automata, PhraseHelper strictPhrases, java.util.function.Function<Query,java.util.Collection<Query>> multiTermQueryRewrite) Build one CharacterRunAutomaton matching any term the query might match.
java.util.List<OffsetsEnum>	getOffsetsEnums(IndexReader reader, int docId, java.lang.String content) The primary method -- return offsets for highlightable words in the specified document.
private static FilteringTokenFilter	newKeepWordFilter(TokenStream tokenStream, CharacterRunAutomaton charRunAutomaton)

Methods inherited from class org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy

getOffsetSource, tokenStream

Methods inherited from class org.apache.lucene.search.uhighlight.FieldOffsetStrategy

createAutomataOffsetsFromTerms, createOffsetsEnumsFromReader, getField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

memoryIndex

private final MemoryIndex memoryIndex

leafReader

private final LeafReader leafReader

preMemIndexFilterAutomaton

private final CharacterRunAutomaton preMemIndexFilterAutomaton

Constructor Detail

MemoryIndexOffsetStrategy

public MemoryIndexOffsetStrategy(java.lang.String field,
                                 java.util.function.Predicate<java.lang.String> fieldMatcher,
                                 BytesRef[] extractedTerms,
                                 PhraseHelper phraseHelper,
                                 CharacterRunAutomaton[] automata,
                                 Analyzer analyzer,
                                 java.util.function.Function<Query,java.util.Collection<Query>> multiTermQueryRewrite)

Method Detail

buildCombinedAutomaton

private static CharacterRunAutomaton buildCombinedAutomaton(java.util.function.Predicate<java.lang.String> fieldMatcher,
                                                            BytesRef[] terms,
                                                            CharacterRunAutomaton[] automata,
                                                            PhraseHelper strictPhrases,
                                                            java.util.function.Function<Query,java.util.Collection<Query>> multiTermQueryRewrite)

Build one CharacterRunAutomaton matching any term the query might match.

getOffsetsEnums

public java.util.List<OffsetsEnum> getOffsetsEnums(IndexReader reader,
                                                   int docId,
                                                   java.lang.String content)
                                            throws java.io.IOException

Description copied from class: FieldOffsetStrategy

The primary method -- return offsets for highlightable words in the specified document. IMPORTANT: remember to close them all.

Specified by:

getOffsetsEnums in class FieldOffsetStrategy

Throws:

java.io.IOException

newKeepWordFilter

private static FilteringTokenFilter newKeepWordFilter(TokenStream tokenStream,
                                                      CharacterRunAutomaton charRunAutomaton)