org.elasticsearch.search.aggregations.metrics.tophits

Class TopHitsBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.metrics.tophits.TopHitsBuilder

All Implemented Interfaces:

ToXContent

public class TopHitsBuilder
extends AbstractAggregationBuilder

Builder for the TopHits aggregation.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
TopHitsBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TopHitsBuilder	addField(String field) Adds a field to loaded and returned.
TopHitsBuilder	addFieldDataField(String name) Adds a field data based field to load and return.
TopHitsBuilder	addHighlightedField(HighlightBuilder.Field field) Adds a highlighted field.
TopHitsBuilder	addHighlightedField(String name) Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5.
TopHitsBuilder	addHighlightedField(String name, int fragmentSize) Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5.
TopHitsBuilder	addHighlightedField(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.
TopHitsBuilder	addHighlightedField(String name, int fragmentSize, int numberOfFragments, int fragmentOffset) Adds a field to be highlighted with a provided fragment size (in characters), a provided (maximum) number of fragments and an offset for the highlight.
TopHitsBuilder	addScriptField(String name, Script script) Adds a script based field to load and return.
TopHitsBuilder	addSort(SortBuilder sort) Adds a generic sort builder.
TopHitsBuilder	addSort(String field, SortOrder order) Adds a sort against the given field name and the sort ordering.
HighlightBuilder	highlightBuilder()
TopHitsBuilder	setExplain(boolean explain) Should each SearchHit be returned with an explanation of the hit (ranking).
TopHitsBuilder	setFetchSource(boolean fetch) Indicates whether the response should contain the stored _source for every hit
TopHitsBuilder	setFetchSource(String[] includes, String[] excludes) Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
TopHitsBuilder	setFetchSource(String include, String exclude) Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
TopHitsBuilder	setFrom(int from) The index to start to return hits from.
TopHitsBuilder	setHighlighterBoundaryChars(char[] boundaryChars)
TopHitsBuilder	setHighlighterBoundaryMaxScan(Integer boundaryMaxScan)
TopHitsBuilder	setHighlighterEncoder(String encoder) The encoder to set for highlighting
TopHitsBuilder	setHighlighterFilter(Boolean highlightFilter)
TopHitsBuilder	setHighlighterFragmenter(String fragmenter)
TopHitsBuilder	setHighlighterFragmentSize(Integer fragmentSize)
TopHitsBuilder	setHighlighterNoMatchSize(Integer noMatchSize) Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight and the field doesn't also define noMatchSize.
TopHitsBuilder	setHighlighterNumOfFragments(Integer numOfFragments)
TopHitsBuilder	setHighlighterOptions(Map<String,Object> options)
TopHitsBuilder	setHighlighterOrder(String order) The order of fragments per field.
TopHitsBuilder	setHighlighterPhraseLimit(Integer phraseLimit) Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.
TopHitsBuilder	setHighlighterPostTags(String... postTags) Explicitly set the post tags that will be used for highlighting.
TopHitsBuilder	setHighlighterPreTags(String... preTags) Explicitly set the pre tags that will be used for highlighting.
TopHitsBuilder	setHighlighterQuery(QueryBuilder highlightQuery) Sets a query to be used for highlighting all fields instead of the search query.
TopHitsBuilder	setHighlighterRequireFieldMatch(boolean requireFieldMatch)
TopHitsBuilder	setHighlighterTagsSchema(String schemaName) Set a tag scheme that encapsulates a built in pre and post tags.
TopHitsBuilder	setHighlighterType(String type) The highlighter type to use.
TopHitsBuilder	setNoFields() Sets no fields to be loaded, resulting in only id and type to be returned per field.
TopHitsBuilder	setSize(int size) The number of search hits to return.
TopHitsBuilder	setTrackScores(boolean trackScores) Applies when sorting, and controls if scores will be tracked as well.
TopHitsBuilder	setVersion(boolean version) Should each SearchHit be returned with its version.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

TopHitsBuilder

public TopHitsBuilder(String name)

Sole constructor.

Method Detail

setFrom

public TopHitsBuilder setFrom(int from)

The index to start to return hits from. Defaults to 0.

setSize

public TopHitsBuilder setSize(int size)

The number of search hits to return. Defaults to 10.

setTrackScores

public TopHitsBuilder setTrackScores(boolean trackScores)

Applies when sorting, and controls if scores will be tracked as well. Defaults to false.

setExplain

public TopHitsBuilder setExplain(boolean explain)

Should each SearchHit be returned with an explanation of the hit (ranking).

setVersion

public TopHitsBuilder setVersion(boolean version)

Should each SearchHit be returned with its version.

addField

public TopHitsBuilder addField(String field)

Adds a field to loaded and returned.

setNoFields

public TopHitsBuilder setNoFields()

Sets no fields to be loaded, resulting in only id and type to be returned per field.

setFetchSource

public TopHitsBuilder setFetchSource(boolean fetch)

Indicates whether the response should contain the stored _source for every hit

setFetchSource

public TopHitsBuilder setFetchSource(@Nullable
                            String include,
                            @Nullable
                            String exclude)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

include - An optional include (optionally wildcarded) pattern to filter the returned _source

exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source

setFetchSource

public TopHitsBuilder setFetchSource(@Nullable
                            String[] includes,
                            @Nullable
                            String[] excludes)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

includes - An optional list of include (optionally wildcarded) pattern to filter the returned _source

excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source

addFieldDataField

public TopHitsBuilder addFieldDataField(String name)

Adds a field data based field to load and return. The field does not have to be stored, but its recommended to use non analyzed or numeric fields.

Parameters:

name - The field to get from the field data cache

addScriptField

public TopHitsBuilder addScriptField(String name,
                            Script script)

Adds a script based field to load and return. The field does not have to be stored, but its recommended to use non analyzed or numeric fields.

Parameters:

name - The name that will represent this value in the return hit

script - The script to use

addSort

public TopHitsBuilder addSort(String field,
                     SortOrder order)

Adds a sort against the given field name and the sort ordering.

Parameters:

field - The name of the field

order - The sort ordering

addSort

public TopHitsBuilder addSort(SortBuilder sort)

Adds a generic sort builder.

See Also:

SortBuilders

addHighlightedField

public TopHitsBuilder addHighlightedField(String name)

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

Parameters:

name - The field to highlight

addHighlightedField

public TopHitsBuilder addHighlightedField(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

addHighlightedField

public TopHitsBuilder addHighlightedField(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

addHighlightedField

public TopHitsBuilder addHighlightedField(String name,
                                 int fragmentSize,
                                 int numberOfFragments,
                                 int fragmentOffset)

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

Parameters:

name - The field to highlight

fragmentSize - The size of a fragment in characters

numberOfFragments - The (maximum) number of fragments

addHighlightedField

public TopHitsBuilder addHighlightedField(HighlightBuilder.Field field)

Adds a highlighted field.

setHighlighterTagsSchema

public TopHitsBuilder setHighlighterTagsSchema(String schemaName)

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

Parameters:

schemaName - The tag scheme name

setHighlighterFragmentSize

public TopHitsBuilder setHighlighterFragmentSize(Integer fragmentSize)

setHighlighterNumOfFragments

public TopHitsBuilder setHighlighterNumOfFragments(Integer numOfFragments)

setHighlighterFilter

public TopHitsBuilder setHighlighterFilter(Boolean highlightFilter)

setHighlighterEncoder

public TopHitsBuilder setHighlighterEncoder(String encoder)

The encoder to set for highlighting

setHighlighterPreTags

public TopHitsBuilder setHighlighterPreTags(String... preTags)

Explicitly set the pre tags that will be used for highlighting.

setHighlighterPostTags

public TopHitsBuilder setHighlighterPostTags(String... postTags)

Explicitly set the post tags that will be used for highlighting.

setHighlighterOrder

public TopHitsBuilder setHighlighterOrder(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.

setHighlighterRequireFieldMatch

public TopHitsBuilder setHighlighterRequireFieldMatch(boolean requireFieldMatch)

setHighlighterBoundaryMaxScan

public TopHitsBuilder setHighlighterBoundaryMaxScan(Integer boundaryMaxScan)

setHighlighterBoundaryChars

public TopHitsBuilder setHighlighterBoundaryChars(char[] boundaryChars)

setHighlighterType

public TopHitsBuilder setHighlighterType(String type)

The highlighter type to use.

setHighlighterFragmenter

public TopHitsBuilder setHighlighterFragmenter(String fragmenter)

setHighlighterQuery

public TopHitsBuilder setHighlighterQuery(QueryBuilder highlightQuery)

Sets a query to be used for highlighting all fields instead of the search query.

setHighlighterNoMatchSize

public TopHitsBuilder setHighlighterNoMatchSize(Integer noMatchSize)

Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight and the field doesn't also define noMatchSize.

Parameters:

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

Returns:

this builder for chaining

setHighlighterPhraseLimit

public TopHitsBuilder setHighlighterPhraseLimit(Integer phraseLimit)

Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.

setHighlighterOptions

public TopHitsBuilder setHighlighterOptions(Map<String,Object> options)

toXContent

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

Throws:

IOException

highlightBuilder

public HighlightBuilder highlightBuilder()