org.elasticsearch.search.highlight

Class HighlightBuilder.Field

java.lang.Object

org.elasticsearch.search.highlight.HighlightBuilder.Field

Enclosing class:

HighlightBuilder

public static class HighlightBuilder.Field
extends Object

Constructor Summary

Constructors

Constructor and Description
HighlightBuilder.Field(String name)

Method Summary

Methods

Modifier and Type	Method and Description
HighlightBuilder.Field	boundaryChars(char[] boundaryChars)
HighlightBuilder.Field	boundaryMaxScan(int boundaryMaxScan)
HighlightBuilder.Field	forceSource(boolean forceSource) Forces the highlighting to highlight this field based on the source even if this field is stored separately.
HighlightBuilder.Field	fragmenter(String fragmenter) Sets what fragmenter to use to break up text that is eligible for highlighting.
HighlightBuilder.Field	fragmentOffset(int fragmentOffset)
HighlightBuilder.Field	fragmentSize(int fragmentSize)
HighlightBuilder.Field	highlighterType(String highlighterType) Set type of highlighter to use.
HighlightBuilder.Field	highlightFilter(boolean highlightFilter)
HighlightBuilder.Field	highlightQuery(QueryBuilder highlightQuery) Sets a query to use for highlighting this field instead of the search query.
HighlightBuilder.Field	matchedFields(String... matchedFields) Set the matched fields to highlight against this field data.
String	name()
HighlightBuilder.Field	noMatchSize(Integer noMatchSize) Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight.
HighlightBuilder.Field	numOfFragments(int numOfFragments)
HighlightBuilder.Field	options(Map<String,Object> options) Allows to set custom options for custom highlighters.
HighlightBuilder.Field	order(String order) The order of fragments per field.
HighlightBuilder.Field	phraseLimit(Integer phraseLimit) Sets the maximum number of phrases the fvh will consider.
HighlightBuilder.Field	postTags(String... postTags) Explicitly set the post tags for this field that will be used for highlighting.
HighlightBuilder.Field	preTags(String... preTags) Explicitly set the pre tags for this field that will be used for highlighting.
HighlightBuilder.Field	requireFieldMatch(boolean requireFieldMatch)

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightBuilder.Field

public HighlightBuilder.Field(String name)

Method Detail

name

public String name()

preTags

public HighlightBuilder.Field preTags(String... preTags)

Explicitly set the pre tags for this field that will be used for highlighting. This overrides global settings set by HighlightBuilder.preTags(String...).

postTags

public HighlightBuilder.Field postTags(String... postTags)

Explicitly set the post tags for this field that will be used for highlighting. This overrides global settings set by HighlightBuilder.postTags(String...).

fragmentSize

public HighlightBuilder.Field fragmentSize(int fragmentSize)

fragmentOffset

public HighlightBuilder.Field fragmentOffset(int fragmentOffset)

numOfFragments

public HighlightBuilder.Field numOfFragments(int numOfFragments)

highlightFilter

public HighlightBuilder.Field highlightFilter(boolean highlightFilter)

order

public HighlightBuilder.Field order(String order)

The order of fragments per field. By default, ordered by the order in the highlighted text. Can be score, which then it will be ordered by score of the fragments. This overrides global settings set by HighlightBuilder.order(String).

requireFieldMatch

public HighlightBuilder.Field requireFieldMatch(boolean requireFieldMatch)

boundaryMaxScan

public HighlightBuilder.Field boundaryMaxScan(int boundaryMaxScan)

boundaryChars

public HighlightBuilder.Field boundaryChars(char[] boundaryChars)

highlighterType

public HighlightBuilder.Field highlighterType(String highlighterType)

Set type of highlighter to use. Supported types are highlighter, fast-vector-highlighter nad postings-highlighter. This overrides global settings set by HighlightBuilder.highlighterType(String).

fragmenter

public HighlightBuilder.Field fragmenter(String fragmenter)

Sets what fragmenter to use to break up text that is eligible for highlighting. This option is only applicable when using plain / normal highlighter. This overrides global settings set by HighlightBuilder.fragmenter(String).

highlightQuery

public HighlightBuilder.Field highlightQuery(QueryBuilder highlightQuery)

Sets a query to use for highlighting this field instead of the search query.

noMatchSize

public HighlightBuilder.Field noMatchSize(Integer noMatchSize)

Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight.

Parameters:

noMatchSize - integer to set or null to leave out of request. default is null.

Returns:

this for chaining

options

public HighlightBuilder.Field options(Map<String,Object> options)

Allows to set custom options for custom highlighters. This overrides global settings set by HighlightBuilder.options(Map).

matchedFields

public HighlightBuilder.Field matchedFields(String... matchedFields)

Set the matched fields to highlight against this field data. Default to null, meaning just the named field. If you provide a list of fields here then don't forget to include name as it is not automatically included.

phraseLimit

public HighlightBuilder.Field phraseLimit(Integer phraseLimit)

Sets the maximum number of phrases the fvh will consider.

Parameters:

phraseLimit - maximum number of phrases the fvh will consider

Returns:

this for chaining

forceSource

public HighlightBuilder.Field forceSource(boolean forceSource)

Forces the highlighting to highlight this field based on the source even if this field is stored separately.