Class BaseFragmentsBuilder
- java.lang.Object
-
- org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
-
- All Implemented Interfaces:
FragmentsBuilder
- Direct Known Subclasses:
ScoreOrderFragmentsBuilder,SimpleFragmentsBuilder
public abstract class BaseFragmentsBuilder extends Object implements FragmentsBuilder
Base FragmentsBuilder implementation that supports colored pre/post tags and multivalued fields.Uses
BoundaryScannerto determine fragments.
-
-
Field Summary
Fields Modifier and Type Field Description static String[]COLORED_POST_TAGSstatic String[]COLORED_PRE_TAGSprotected String[]postTagsprotected String[]preTags
-
Constructor Summary
Constructors Modifier Constructor Description protectedBaseFragmentsBuilder()protectedBaseFragmentsBuilder(String[] preTags, String[] postTags)protectedBaseFragmentsBuilder(String[] preTags, String[] postTags, BoundaryScanner boundaryScanner)protectedBaseFragmentsBuilder(BoundaryScanner boundaryScanner)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description StringcreateFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList)create a fragment.StringcreateFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, String[] preTags, String[] postTags, Encoder encoder)create a fragment.String[]createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments)create multiple fragments.String[]createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments, String[] preTags, String[] postTags, Encoder encoder)create multiple fragments.protected List<FieldFragList.WeightedFragInfo>discreteMultiValueHighlighting(List<FieldFragList.WeightedFragInfo> fragInfos, Field[] fields)protected Field[]getFields(IndexReader reader, int docId, String fieldName)protected StringgetFragmentSource(StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset)protected StringgetFragmentSourceMSO(StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset, int[] modifiedStartOffset)chargetMultiValuedSeparator()protected StringgetPostTag(int num)protected StringgetPostTag(String[] postTags, int num)protected StringgetPreTag(int num)protected StringgetPreTag(String[] preTags, int num)abstract List<FieldFragList.WeightedFragInfo>getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo> src)booleanisDiscreteMultiValueHighlighting()protected StringmakeFragment(StringBuilder buffer, int[] index, Field[] values, FieldFragList.WeightedFragInfo fragInfo, String[] preTags, String[] postTags, Encoder encoder)voidsetDiscreteMultiValueHighlighting(boolean discreteMultiValueHighlighting)voidsetMultiValuedSeparator(char separator)
-
-
-
Constructor Detail
-
BaseFragmentsBuilder
protected BaseFragmentsBuilder()
-
BaseFragmentsBuilder
protected BaseFragmentsBuilder(BoundaryScanner boundaryScanner)
-
BaseFragmentsBuilder
protected BaseFragmentsBuilder(String[] preTags, String[] postTags, BoundaryScanner boundaryScanner)
-
-
Method Detail
-
getWeightedFragInfoList
public abstract List<FieldFragList.WeightedFragInfo> getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo> src)
-
createFragment
public String createFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList) throws IOException
Description copied from interface:FragmentsBuildercreate a fragment.- Specified by:
createFragmentin interfaceFragmentsBuilder- Parameters:
reader- IndexReader of the indexdocId- document id to be highlightedfieldName- field of the document to be highlightedfieldFragList- FieldFragList object- Returns:
- a created fragment or null when no fragment created
- Throws:
IOException- If there is a low-level I/O error
-
createFragments
public String[] createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments) throws IOException
Description copied from interface:FragmentsBuildercreate multiple fragments.- Specified by:
createFragmentsin interfaceFragmentsBuilder- Parameters:
reader- IndexReader of the indexdocId- document id to be highlighterfieldName- field of the document to be highlightedfieldFragList- FieldFragList objectmaxNumFragments- maximum number of fragments- Returns:
- created fragments or null when no fragments created. size of the array can be less than maxNumFragments
- Throws:
IOException- If there is a low-level I/O error
-
createFragment
public String createFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, String[] preTags, String[] postTags, Encoder encoder) throws IOException
Description copied from interface:FragmentsBuildercreate a fragment.- Specified by:
createFragmentin interfaceFragmentsBuilder- Parameters:
reader- IndexReader of the indexdocId- document id to be highlightedfieldName- field of the document to be highlightedfieldFragList- FieldFragList objectpreTags- pre-tags to be used to highlight termspostTags- post-tags to be used to highlight termsencoder- an encoder that generates encoded text- Returns:
- a created fragment or null when no fragment created
- Throws:
IOException- If there is a low-level I/O error
-
createFragments
public String[] createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments, String[] preTags, String[] postTags, Encoder encoder) throws IOException
Description copied from interface:FragmentsBuildercreate multiple fragments.- Specified by:
createFragmentsin interfaceFragmentsBuilder- Parameters:
reader- IndexReader of the indexdocId- document id to be highlighterfieldName- field of the document to be highlightedfieldFragList- FieldFragList objectmaxNumFragments- maximum number of fragmentspreTags- pre-tags to be used to highlight termspostTags- post-tags to be used to highlight termsencoder- an encoder that generates encoded text- Returns:
- created fragments or null when no fragments created. size of the array can be less than maxNumFragments
- Throws:
IOException- If there is a low-level I/O error
-
getFields
protected Field[] getFields(IndexReader reader, int docId, String fieldName) throws IOException
- Throws:
IOException
-
makeFragment
protected String makeFragment(StringBuilder buffer, int[] index, Field[] values, FieldFragList.WeightedFragInfo fragInfo, String[] preTags, String[] postTags, Encoder encoder)
-
getFragmentSourceMSO
protected String getFragmentSourceMSO(StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset, int[] modifiedStartOffset)
-
getFragmentSource
protected String getFragmentSource(StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset)
-
discreteMultiValueHighlighting
protected List<FieldFragList.WeightedFragInfo> discreteMultiValueHighlighting(List<FieldFragList.WeightedFragInfo> fragInfos, Field[] fields)
-
setMultiValuedSeparator
public void setMultiValuedSeparator(char separator)
-
getMultiValuedSeparator
public char getMultiValuedSeparator()
-
isDiscreteMultiValueHighlighting
public boolean isDiscreteMultiValueHighlighting()
-
setDiscreteMultiValueHighlighting
public void setDiscreteMultiValueHighlighting(boolean discreteMultiValueHighlighting)
-
getPreTag
protected String getPreTag(int num)
-
getPostTag
protected String getPostTag(int num)
-
-