public abstract class BaseFragmentsBuilder extends java.lang.Object implements FragmentsBuilder
Uses BoundaryScanner
to determine fragments.
Modifier and Type | Field and Description |
---|---|
static java.lang.String[] |
COLORED_POST_TAGS |
static java.lang.String[] |
COLORED_PRE_TAGS |
protected java.lang.String[] |
postTags |
protected java.lang.String[] |
preTags |
Modifier | Constructor and Description |
---|---|
protected |
BaseFragmentsBuilder() |
protected |
BaseFragmentsBuilder(BoundaryScanner boundaryScanner) |
protected |
BaseFragmentsBuilder(java.lang.String[] preTags,
java.lang.String[] postTags) |
protected |
BaseFragmentsBuilder(java.lang.String[] preTags,
java.lang.String[] postTags,
BoundaryScanner boundaryScanner) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createFragment(IndexReader reader,
int docId,
java.lang.String fieldName,
FieldFragList fieldFragList)
create a fragment.
|
java.lang.String |
createFragment(IndexReader reader,
int docId,
java.lang.String fieldName,
FieldFragList fieldFragList,
java.lang.String[] preTags,
java.lang.String[] postTags,
Encoder encoder)
create a fragment.
|
java.lang.String[] |
createFragments(IndexReader reader,
int docId,
java.lang.String fieldName,
FieldFragList fieldFragList,
int maxNumFragments)
create multiple fragments.
|
java.lang.String[] |
createFragments(IndexReader reader,
int docId,
java.lang.String fieldName,
FieldFragList fieldFragList,
int maxNumFragments,
java.lang.String[] preTags,
java.lang.String[] postTags,
Encoder encoder)
create multiple fragments.
|
protected java.util.List<FieldFragList.WeightedFragInfo> |
discreteMultiValueHighlighting(java.util.List<FieldFragList.WeightedFragInfo> fragInfos,
Field[] fields) |
protected Field[] |
getFields(IndexReader reader,
int docId,
java.lang.String fieldName) |
protected java.lang.String |
getFragmentSource(java.lang.StringBuilder buffer,
int[] index,
Field[] values,
int startOffset,
int endOffset) |
protected java.lang.String |
getFragmentSourceMSO(java.lang.StringBuilder buffer,
int[] index,
Field[] values,
int startOffset,
int endOffset,
int[] modifiedStartOffset) |
char |
getMultiValuedSeparator() |
protected java.lang.String |
getPostTag(int num) |
protected java.lang.String |
getPostTag(java.lang.String[] postTags,
int num) |
protected java.lang.String |
getPreTag(int num) |
protected java.lang.String |
getPreTag(java.lang.String[] preTags,
int num) |
abstract java.util.List<FieldFragList.WeightedFragInfo> |
getWeightedFragInfoList(java.util.List<FieldFragList.WeightedFragInfo> src) |
boolean |
isDiscreteMultiValueHighlighting() |
protected java.lang.String |
makeFragment(java.lang.StringBuilder buffer,
int[] index,
Field[] values,
FieldFragList.WeightedFragInfo fragInfo,
java.lang.String[] preTags,
java.lang.String[] postTags,
Encoder encoder) |
void |
setDiscreteMultiValueHighlighting(boolean discreteMultiValueHighlighting) |
void |
setMultiValuedSeparator(char separator) |
protected java.lang.String[] preTags
protected java.lang.String[] postTags
public static final java.lang.String[] COLORED_PRE_TAGS
public static final java.lang.String[] COLORED_POST_TAGS
protected BaseFragmentsBuilder()
protected BaseFragmentsBuilder(java.lang.String[] preTags, java.lang.String[] postTags)
protected BaseFragmentsBuilder(BoundaryScanner boundaryScanner)
protected BaseFragmentsBuilder(java.lang.String[] preTags, java.lang.String[] postTags, BoundaryScanner boundaryScanner)
public abstract java.util.List<FieldFragList.WeightedFragInfo> getWeightedFragInfoList(java.util.List<FieldFragList.WeightedFragInfo> src)
public java.lang.String createFragment(IndexReader reader, int docId, java.lang.String fieldName, FieldFragList fieldFragList) throws java.io.IOException
FragmentsBuilder
createFragment
in interface FragmentsBuilder
reader
- IndexReader of the indexdocId
- document id to be highlightedfieldName
- field of the document to be highlightedfieldFragList
- FieldFragList objectjava.io.IOException
- If there is a low-level I/O errorpublic java.lang.String[] createFragments(IndexReader reader, int docId, java.lang.String fieldName, FieldFragList fieldFragList, int maxNumFragments) throws java.io.IOException
FragmentsBuilder
createFragments
in interface FragmentsBuilder
reader
- IndexReader of the indexdocId
- document id to be highlighterfieldName
- field of the document to be highlightedfieldFragList
- FieldFragList objectmaxNumFragments
- maximum number of fragmentsjava.io.IOException
- If there is a low-level I/O errorpublic java.lang.String createFragment(IndexReader reader, int docId, java.lang.String fieldName, FieldFragList fieldFragList, java.lang.String[] preTags, java.lang.String[] postTags, Encoder encoder) throws java.io.IOException
FragmentsBuilder
createFragment
in interface FragmentsBuilder
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 textjava.io.IOException
- If there is a low-level I/O errorpublic java.lang.String[] createFragments(IndexReader reader, int docId, java.lang.String fieldName, FieldFragList fieldFragList, int maxNumFragments, java.lang.String[] preTags, java.lang.String[] postTags, Encoder encoder) throws java.io.IOException
FragmentsBuilder
createFragments
in interface FragmentsBuilder
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 textjava.io.IOException
- If there is a low-level I/O errorprotected Field[] getFields(IndexReader reader, int docId, java.lang.String fieldName) throws java.io.IOException
java.io.IOException
protected java.lang.String makeFragment(java.lang.StringBuilder buffer, int[] index, Field[] values, FieldFragList.WeightedFragInfo fragInfo, java.lang.String[] preTags, java.lang.String[] postTags, Encoder encoder)
protected java.lang.String getFragmentSourceMSO(java.lang.StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset, int[] modifiedStartOffset)
protected java.lang.String getFragmentSource(java.lang.StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset)
protected java.util.List<FieldFragList.WeightedFragInfo> discreteMultiValueHighlighting(java.util.List<FieldFragList.WeightedFragInfo> fragInfos, Field[] fields)
public void setMultiValuedSeparator(char separator)
public char getMultiValuedSeparator()
public boolean isDiscreteMultiValueHighlighting()
public void setDiscreteMultiValueHighlighting(boolean discreteMultiValueHighlighting)
protected java.lang.String getPreTag(int num)
protected java.lang.String getPostTag(int num)
protected java.lang.String getPreTag(java.lang.String[] preTags, int num)
protected java.lang.String getPostTag(java.lang.String[] postTags, int num)
Copyright © 2000–2019 The Apache Software Foundation. All rights reserved.