org.apache.lucene.search.uhighlight

Class AnalysisOffsetStrategy

java.lang.Object

org.apache.lucene.search.uhighlight.FieldOffsetStrategy

org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy

public class AnalysisOffsetStrategy
extends FieldOffsetStrategy

Uses an Analyzer on content to get offsets. It may use a MemoryIndex too.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary

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

automata, field, strictPhrases, terms

Constructor Summary

Constructors

Constructor and Description
AnalysisOffsetStrategy(String field, BytesRef[] extractedTerms, PhraseHelper phraseHelper, CharacterRunAutomaton[] automata, Analyzer analyzer)

Method Summary

Modifier and Type	Method and Description
List<OffsetsEnum>	getOffsetsEnums(IndexReader reader, int docId, String content) The primary method -- return offsets for highlightable words in the specified document.
UnifiedHighlighter.OffsetSource	getOffsetSource()
protected TokenStream	tokenStream(String content)

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

createOffsetsEnumFromTokenStream, createOffsetsEnums, createOffsetsEnumsFromReader, getField

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisOffsetStrategy

public AnalysisOffsetStrategy(String field,
                              BytesRef[] extractedTerms,
                              PhraseHelper phraseHelper,
                              CharacterRunAutomaton[] automata,
                              Analyzer analyzer)

Method Detail

getOffsetSource

public UnifiedHighlighter.OffsetSource getOffsetSource()

Specified by:

getOffsetSource in class FieldOffsetStrategy

getOffsetsEnums

public List<OffsetsEnum> getOffsetsEnums(IndexReader reader,
                                         int docId,
                                         String content)
                                  throws 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:

IOException

tokenStream

protected TokenStream tokenStream(String content)
                           throws IOException

Throws:

IOException