org.apache.lucene.search.uhighlight

Class PostingsOffsetStrategy

java.lang.Object

org.apache.lucene.search.uhighlight.FieldOffsetStrategy

org.apache.lucene.search.uhighlight.PostingsOffsetStrategy

public class PostingsOffsetStrategy
extends FieldOffsetStrategy

Uses offsets in postings -- IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS. This does not support multi-term queries; the highlighter will fallback on analysis for that.

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, phraseHelper, terms

Constructor Summary

Constructors

Constructor and Description
PostingsOffsetStrategy(String field, BytesRef[] queryTerms, PhraseHelper phraseHelper, CharacterRunAutomaton[] automata)

Method Summary

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

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

createOffsetsEnumFromReader, createOffsetsEnumsForAutomata, createOffsetsEnumsForTerms, getField

Methods inherited from class java.lang.Object

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

Constructor Detail

PostingsOffsetStrategy

public PostingsOffsetStrategy(String field,
                              BytesRef[] queryTerms,
                              PhraseHelper phraseHelper,
                              CharacterRunAutomaton[] automata)

Method Detail

getOffsetsEnum

public OffsetsEnum getOffsetsEnum(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. Callers are expected to close the returned OffsetsEnum when it has been finished with

Specified by:

getOffsetsEnum in class FieldOffsetStrategy

Throws:

IOException

getOffsetSource

public UnifiedHighlighter.OffsetSource getOffsetSource()

Specified by:

getOffsetSource in class FieldOffsetStrategy