public interface FragmentsBuilder
FragmentsBuilder
is an interface for fragments (snippets) builder classes.
A FragmentsBuilder
class can be plugged in to
FastVectorHighlighter
.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.
|
java.lang.String createFragment(IndexReader reader, int docId, java.lang.String fieldName, FieldFragList fieldFragList) throws java.io.IOException
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 errorjava.lang.String[] createFragments(IndexReader reader, int docId, java.lang.String fieldName, FieldFragList fieldFragList, int maxNumFragments) throws java.io.IOException
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 errorjava.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
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 errorjava.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
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 errorCopyright © 2000–2019 The Apache Software Foundation. All rights reserved.