Package org.apache.lucene.search.uhighlight

Class MultiFieldsOffsetStrategy

java.lang.Object

org.apache.lucene.search.uhighlight.FieldOffsetStrategy

org.apache.lucene.search.uhighlight.MultiFieldsOffsetStrategy

public class MultiFieldsOffsetStrategy
extends FieldOffsetStrategy

FieldOffsetStrategy that combines offsets from multiple fields. Used to highlight a single field based on matches from multiple fields.

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

components

Constructor Summary

Constructors

Constructor	Description
MultiFieldsOffsetStrategy(List<FieldOffsetStrategy> fieldsOffsetStrategies)

Method Summary

Modifier and Type	Method	Description
String	getField()
OffsetsEnum	getOffsetsEnum(LeafReader 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, createOffsetsEnumsWeightMatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiFieldsOffsetStrategy

public MultiFieldsOffsetStrategy(List<FieldOffsetStrategy> fieldsOffsetStrategies)

Method Detail

getField

public String getField()

Overrides:

getField in class FieldOffsetStrategy

getOffsetSource

public UnifiedHighlighter.OffsetSource getOffsetSource()

Specified by:

getOffsetSource in class FieldOffsetStrategy

getOffsetsEnum

public OffsetsEnum getOffsetsEnum(LeafReader 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