org.apache.lucene.search.vectorhighlight
Class AbstractFragmentsBuilder

java.lang.Object
  org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
      org.apache.lucene.search.vectorhighlight.AbstractFragmentsBuilder

All Implemented Interfaces:

org.apache.lucene.search.vectorhighlight.FragmentsBuilder

Direct Known Subclasses:

XScoreOrderFragmentsBuilder, XSimpleFragmentsBuilder

public abstract class AbstractFragmentsBuilder
extends org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

Abstract FragmentsBuilder implementation that detects whether highlight hits occurred on a field that is multivalued (Basically fields that have the same name) and splits the highlight snippets according to a single field boundary. This avoids that a highlight hit is shown as one hit whilst it is actually a hit on multiple fields.

Field Summary

Fields inherited from class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

COLORED_POST_TAGS, COLORED_PRE_TAGS, postTags, preTags

Constructor Summary

protected	AbstractFragmentsBuilder()
protected	AbstractFragmentsBuilder(org.apache.lucene.search.vectorhighlight.BoundaryScanner boundaryScanner)
protected	AbstractFragmentsBuilder(String[] preTags, String[] postTags)
	AbstractFragmentsBuilder(String[] preTags, String[] postTags, org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)

Method Summary

String[]	createFragments(org.apache.lucene.index.IndexReader reader, int docId, String fieldName, org.apache.lucene.search.vectorhighlight.FieldFragList fieldFragList, int maxNumFragments, String[] preTags, String[] postTags, org.apache.lucene.search.highlight.Encoder encoder)
protected List<org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo>	discreteMultiValueHighlighting(List<org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo> fragInfos, org.apache.lucene.document.Field[] fields)
void	setDiscreteMultiValueHighlighting(boolean discreteMultiValueHighlighting)

Methods inherited from class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

createFragment, createFragment, createFragments, getFields, getFieldValues, getFragmentSource, getFragmentSource, getFragmentSourceMSO, getMultiValuedSeparator, getPostTag, getPostTag, getPreTag, getPreTag, getWeightedFragInfoList, makeFragment, makeFragment, setMultiValuedSeparator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFragmentsBuilder

protected AbstractFragmentsBuilder()

AbstractFragmentsBuilder

protected AbstractFragmentsBuilder(org.apache.lucene.search.vectorhighlight.BoundaryScanner boundaryScanner)

AbstractFragmentsBuilder

protected AbstractFragmentsBuilder(String[] preTags,
                                   String[] postTags)

AbstractFragmentsBuilder

public AbstractFragmentsBuilder(String[] preTags,
                                String[] postTags,
                                org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)

Method Detail

setDiscreteMultiValueHighlighting

public void setDiscreteMultiValueHighlighting(boolean discreteMultiValueHighlighting)

createFragments

public String[] createFragments(org.apache.lucene.index.IndexReader reader,
                                int docId,
                                String fieldName,
                                org.apache.lucene.search.vectorhighlight.FieldFragList fieldFragList,
                                int maxNumFragments,
                                String[] preTags,
                                String[] postTags,
                                org.apache.lucene.search.highlight.Encoder encoder)
                         throws IOException

Specified by:

createFragments in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder

Overrides:

createFragments in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder

Throws:

IOException

discreteMultiValueHighlighting

protected List<org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo> discreteMultiValueHighlighting(List<org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo> fragInfos,
                                                                                                                       org.apache.lucene.document.Field[] fields)