Package org.elasticsearch.search.fetch.subphase.highlight

Class HighlightBuilder

java.lang.Object

org.elasticsearch.search.fetch.subphase.highlight.AbstractHighlighterBuilder<HighlightBuilder>

org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder

All Implemented Interfaces:

Writeable, Rewriteable<HighlightBuilder>, ToXContent, ToXContentObject

public class HighlightBuilder
extends AbstractHighlighterBuilder<HighlightBuilder>

A builder for search highlighting. Settings can control how large fields are summarized to show only selected snippets ("fragments") containing search terms.

See Also:

• SearchSourceBuilder.highlight()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HighlightBuilder.BoundaryScannerType
static class	HighlightBuilder.Field
static enum	HighlightBuilder.Order

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ENCODER	the default encoder setting
static final boolean	DEFAULT_FORCE_SOURCE	default for whether to highlight fields based on the source even if stored separately
static final int	DEFAULT_FRAGMENT_CHAR_SIZE	the default number of fragments size in characters
static final boolean	DEFAULT_HIGHLIGHT_FILTER	default for whether fvh should provide highlighting on filter clauses
static final Integer	DEFAULT_MAX_ANALYZED_OFFSET	default for whether to stop highlighting at the defined max_analyzed_offset to avoid exceptions for longer texts
static final int	DEFAULT_NO_MATCH_SIZE	default for fragment size when there are no matches
static final int	DEFAULT_NUMBER_OF_FRAGMENTS	the default number of fragments for highlighting
static final int	DEFAULT_PHRASE_LIMIT	default for the maximum number of phrases the fvh will consider
static final boolean	DEFAULT_REQUIRE_FIELD_MATCH	default for whether a field should be highlighted only if a query matches that field
static final boolean	DEFAULT_SCORE_ORDERED	default for highlight fragments being ordered by score
static final String[]	DEFAULT_STYLED_POST_TAGS	the default closing tags when tag_schema = "styled"
static final String[]	DEFAULT_STYLED_PRE_TAG	the default opening tags when tag_schema = "styled"

Fields inherited from class org.elasticsearch.search.fetch.subphase.highlight.AbstractHighlighterBuilder

BOUNDARY_CHARS_FIELD, BOUNDARY_MAX_SCAN_FIELD, BOUNDARY_SCANNER_FIELD, BOUNDARY_SCANNER_LOCALE_FIELD, boundaryChars, boundaryMaxScan, boundaryScannerLocale, boundaryScannerType, ENCODER_FIELD, FIELDS_FIELD, FORCE_SOURCE_FIELD, forceSource, FRAGMENT_OFFSET_FIELD, FRAGMENT_SIZE_FIELD, fragmenter, FRAGMENTER_FIELD, fragmentSize, HIGHLIGHT_FILTER_FIELD, HIGHLIGHT_QUERY_FIELD, highlighterType, highlightFilter, highlightQuery, MATCHED_FIELDS_FIELD, MAX_ANALYZED_OFFSET_FIELD, maxAnalyzedOffset, NO_MATCH_SIZE_FIELD, noMatchSize, NUMBER_OF_FRAGMENTS_FIELD, numOfFragments, options, OPTIONS_FIELD, order, ORDER_FIELD, PHRASE_LIMIT_FIELD, phraseLimit, POST_TAGS_FIELD, postTags, PRE_TAGS_FIELD, preTags, REQUIRE_FIELD_MATCH_FIELD, requireFieldMatch, TYPE_FIELD

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
HighlightBuilder()
HighlightBuilder(StreamInput in)	Read from a stream.
HighlightBuilder(HighlightBuilder template, QueryBuilder highlightQuery, List<HighlightBuilder.Field> fields)

Method Summary

Modifier and Type	Method	Description
SearchHighlightContext	build(SearchExecutionContext context)
protected boolean	doEquals(HighlightBuilder other)	fields only present in subclass should be checked for equality in the implementation
protected int	doHashCode()	fields only present in subclass should contribute to hashCode in the implementation
protected void	doWriteTo(StreamOutput out)
String	encoder()	Getter for encoder(String)
HighlightBuilder	encoder(String encoder)	Set encoder for the highlighting are html and default.
HighlightBuilder	field(String name)	Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5 using the default encoder
HighlightBuilder	field(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(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	field(String name, int fragmentSize, int numberOfFragments, int fragmentOffset)	Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.
HighlightBuilder	field(HighlightBuilder.Field field)
List<HighlightBuilder.Field>	fields()
static HighlightBuilder	fromXContent(XContentParser p)
void	innerXContent(XContentBuilder builder)
HighlightBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
HighlightBuilder	tagsSchema(String schemaName)	Set a tag scheme that encapsulates a built in pre and post tags.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Boolean	useExplicitFieldOrder()	Gets value set with useExplicitFieldOrder(boolean)
HighlightBuilder	useExplicitFieldOrder(boolean useExplicitFieldOrder)	Send the fields to be highlighted using a syntax that is specific about the order in which they should be highlighted.

Methods inherited from class org.elasticsearch.search.fetch.subphase.highlight.AbstractHighlighterBuilder

boundaryChars, boundaryChars, boundaryMaxScan, boundaryMaxScan, boundaryScannerLocale, boundaryScannerLocale, boundaryScannerType, boundaryScannerType, boundaryScannerType, equals, forceSource, forceSource, fragmenter, fragmenter, fragmentSize, fragmentSize, hashCode, highlighterType, highlighterType, highlightFilter, highlightFilter, highlightQuery, highlightQuery, maxAnalyzedOffset, maxAnalyzedOffset, noMatchSize, noMatchSize, numOfFragments, numOfFragments, options, options, order, order, order, phraseLimit, phraseLimit, postTags, postTags, preTags, preTags, requireFieldMatch, requireFieldMatch, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DEFAULT_FORCE_SOURCE

public static final boolean DEFAULT_FORCE_SOURCE

default for whether to highlight fields based on the source even if stored separately

See Also:

• Constant Field Values

DEFAULT_REQUIRE_FIELD_MATCH

public static final boolean DEFAULT_REQUIRE_FIELD_MATCH

default for whether a field should be highlighted only if a query matches that field

See Also:

• Constant Field Values

DEFAULT_MAX_ANALYZED_OFFSET

public static final Integer DEFAULT_MAX_ANALYZED_OFFSET

default for whether to stop highlighting at the defined max_analyzed_offset to avoid exceptions for longer texts

DEFAULT_HIGHLIGHT_FILTER

public static final boolean DEFAULT_HIGHLIGHT_FILTER

default for whether fvh should provide highlighting on filter clauses

See Also:

• Constant Field Values

DEFAULT_SCORE_ORDERED

public static final boolean DEFAULT_SCORE_ORDERED

default for highlight fragments being ordered by score

See Also:

• Constant Field Values

DEFAULT_ENCODER

public static final String DEFAULT_ENCODER

the default encoder setting

See Also:

• Constant Field Values

DEFAULT_PHRASE_LIMIT

public static final int DEFAULT_PHRASE_LIMIT

default for the maximum number of phrases the fvh will consider

See Also:

• Constant Field Values

DEFAULT_NO_MATCH_SIZE

public static final int DEFAULT_NO_MATCH_SIZE

default for fragment size when there are no matches

See Also:

• Constant Field Values

DEFAULT_NUMBER_OF_FRAGMENTS

public static final int DEFAULT_NUMBER_OF_FRAGMENTS

the default number of fragments for highlighting

See Also:

• Constant Field Values

DEFAULT_FRAGMENT_CHAR_SIZE

public static final int DEFAULT_FRAGMENT_CHAR_SIZE

the default number of fragments size in characters

See Also:

• Constant Field Values

DEFAULT_STYLED_PRE_TAG

public static final String[] DEFAULT_STYLED_PRE_TAG

the default opening tags when tag_schema = "styled"

DEFAULT_STYLED_POST_TAGS

public static final String[] DEFAULT_STYLED_POST_TAGS

the default closing tags when tag_schema = "styled"

Constructor Details

HighlightBuilder

public HighlightBuilder()

HighlightBuilder

public HighlightBuilder(HighlightBuilder template,
 QueryBuilder highlightQuery,
 List<HighlightBuilder.Field> fields)

HighlightBuilder

public HighlightBuilder(StreamInput in)
                 throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractHighlighterBuilder<HighlightBuilder>

Throws:

IOException

field

public HighlightBuilder field(String name)

Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5 using the default encoder

Parameters:

name - The field to highlight

field

public HighlightBuilder field(String name,
 int fragmentSize)

Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5.

Parameters:

name - The field to highlight

fragmentSize - The size of a fragment in characters

field

public HighlightBuilder field(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.

Parameters:

name - The field to highlight

fragmentSize - The size of a fragment in characters

numberOfFragments - The (maximum) number of fragments

field

public HighlightBuilder field(String name,
 int fragmentSize,
 int numberOfFragments,
 int fragmentOffset)

Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.

Parameters:

name - The field to highlight

fragmentSize - The size of a fragment in characters

numberOfFragments - The (maximum) number of fragments

fragmentOffset - The offset from the start of the fragment to the start of the highlight

field

public HighlightBuilder field(HighlightBuilder.Field field)

fields

public List<HighlightBuilder.Field> fields()

tagsSchema

public HighlightBuilder tagsSchema(String schemaName)

Set a tag scheme that encapsulates a built in pre and post tags. The allowed schemes are styled and default.

Parameters:

schemaName - The tag scheme name

encoder

public HighlightBuilder encoder(String encoder)

Set encoder for the highlighting are html and default.

Parameters:

encoder - name

encoder

public String encoder()

Getter for encoder(String)

useExplicitFieldOrder

public HighlightBuilder useExplicitFieldOrder(boolean useExplicitFieldOrder)

Send the fields to be highlighted using a syntax that is specific about the order in which they should be highlighted.

Returns:

this for chaining

useExplicitFieldOrder

public Boolean useExplicitFieldOrder()

Gets value set with useExplicitFieldOrder(boolean)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class AbstractHighlighterBuilder<HighlightBuilder>

Throws:

IOException

fromXContent

public static HighlightBuilder fromXContent(XContentParser p)

build

public SearchHighlightContext build(SearchExecutionContext context)
                             throws IOException

Throws:

IOException

innerXContent

public void innerXContent(XContentBuilder builder)
                   throws IOException

Specified by:

innerXContent in class AbstractHighlighterBuilder<HighlightBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Description copied from class: AbstractHighlighterBuilder

fields only present in subclass should contribute to hashCode in the implementation

Specified by:

doHashCode in class AbstractHighlighterBuilder<HighlightBuilder>

doEquals

protected boolean doEquals(HighlightBuilder other)

Description copied from class: AbstractHighlighterBuilder

fields only present in subclass should be checked for equality in the implementation

Specified by:

doEquals in class AbstractHighlighterBuilder<HighlightBuilder>

rewrite

public HighlightBuilder rewrite(QueryRewriteContext ctx)
                         throws IOException

Description copied from interface: Rewriteable

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

Throws:

IOException