com.arakelian.elastic.model.search

Interface Highlighter.Field

All Superinterfaces:

Highlighter, java.io.Serializable

Enclosing interface:

Highlighter

@Value.Immutable(copy=false)
public static interface Highlighter.Field
extends Highlighter

Nested Class Summary

Nested classes/interfaces inherited from interface com.arakelian.elastic.model.search.Highlighter

Highlighter.BoundaryScanner, Highlighter.Encoder, Highlighter.Field, Highlighter.Fragmenter, Highlighter.Highlight, Highlighter.Order, Highlighter.TagsSchema, Highlighter.Type

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getFragmentOffset() Returns the margin from which you want to start highlighting.
default java.util.List<java.lang.String>	getMatchedFields() Returns a list of fields whose matches are combined to highlight a single field.
java.lang.String	getName() Returns the field name to retrieve highlights for.
static Highlighter.Field	of(java.lang.String name)

Methods inherited from interface com.arakelian.elastic.model.search.Highlighter

getBoundaryChars, getBoundaryMaxScan, getBoundaryScanner, getBoundaryScannerLocale, getEncoder, getFragmenter, getFragmentSize, getHighlightQuery, getNoMatchSize, getNumberOfFragments, getOrder, getPhraseLimit, getPostTags, getPreTags, getTagsSchema, getType, isForceSource, isHighlightFilter, isRequireFieldMatch

Method Detail

of

static Highlighter.Field of(java.lang.String name)

getFragmentOffset

java.lang.Integer getFragmentOffset()

Returns the margin from which you want to start highlighting. Only valid when using the fvh highlighter.

Returns:

the margin from which you want to start highlighting

getMatchedFields

@Value.Default
default java.util.List<java.lang.String> getMatchedFields()

Returns a list of fields whose matches are combined to highlight a single field.

This is most intuitive for multifields that analyze the same string in different ways. All matched_fields must have term_vector set to with_positions_offsets, but only the field to which the matches are combined is loaded so only that field benefits from having store set to yes. Only valid for the fvh highlighter.

Returns:

a list of fields whose matches are combined to highlight a single field.

getName

java.lang.String getName()

Returns the field name to retrieve highlights for.

You can use wildcards to specify fields. For example, you could specify comment_* to get highlights for all text and keyword fields that start with comment_.

Returns:

the field name to retrieve highlights for.