|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.search.highlight.HighlightBuilder
public class HighlightBuilder
A builder for search highlighting.
SearchSourceBuilder.highlight()
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent |
---|
ToXContent.MapParams, ToXContent.Params |
Field Summary |
---|
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent |
---|
EMPTY_PARAMS |
Constructor Summary | |
---|---|
HighlightBuilder()
|
Method Summary | |
---|---|
HighlightBuilder |
field(java.lang.String name)
Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5. |
HighlightBuilder |
field(java.lang.String name,
int fragmentSize)
Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5. |
HighlightBuilder |
field(java.lang.String name,
int fragmentSize,
int numberOfFragments)
Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments. |
HighlightBuilder |
order(java.lang.String order)
The order of fragments per field. |
HighlightBuilder |
postTags(java.lang.String... postTags)
Explicitly set the post tags that will be used for highlighting. |
HighlightBuilder |
preTags(java.lang.String... preTags)
Explicitly set the pre tags that will be used for highlighting. |
HighlightBuilder |
tagsSchema(java.lang.String schemaName)
Set a tag scheme that encapsulates a built in pre and post tags. |
void |
toXContent(XContentBuilder builder,
ToXContent.Params params)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HighlightBuilder()
Method Detail |
---|
public HighlightBuilder field(java.lang.String name)
name
- The field to highlightpublic HighlightBuilder field(java.lang.String name, int fragmentSize)
name
- The field to highlightfragmentSize
- The size of a fragment in characterspublic HighlightBuilder field(java.lang.String name, int fragmentSize, int numberOfFragments)
name
- The field to highlightfragmentSize
- The size of a fragment in charactersnumberOfFragments
- The (maximum) number of fragmentspublic HighlightBuilder tagsSchema(java.lang.String schemaName)
schemaName
- The tag scheme namepublic HighlightBuilder preTags(java.lang.String... preTags)
public HighlightBuilder postTags(java.lang.String... postTags)
public HighlightBuilder order(java.lang.String order)
public void toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |