Package | Description |
---|---|
org.elasticsearch.search.aggregations | |
org.elasticsearch.search.aggregations.metrics.tophits |
Modifier and Type | Method and Description |
---|---|
static TopHitsBuilder |
AggregationBuilders.topHits(String name)
Create a new
TopHits aggregation with the given name. |
Modifier and Type | Method and Description |
---|---|
TopHitsBuilder |
TopHitsBuilder.addFieldDataField(String name)
Adds a field data based field to load and return.
|
TopHitsBuilder |
TopHitsBuilder.addHighlightedField(HighlightBuilder.Field field)
Adds a highlighted field.
|
TopHitsBuilder |
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 |
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 |
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 |
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 |
TopHitsBuilder.addScriptField(String name,
String script)
Adds a script based field to load and return.
|
TopHitsBuilder |
TopHitsBuilder.addScriptField(String name,
String script,
Map<String,Object> params)
Adds a script based field to load and return.
|
TopHitsBuilder |
TopHitsBuilder.addScriptField(String name,
String lang,
String script,
Map<String,Object> params)
Adds a script based field to load and return.
|
TopHitsBuilder |
TopHitsBuilder.addSort(SortBuilder sort)
Adds a generic sort builder.
|
TopHitsBuilder |
TopHitsBuilder.addSort(String field,
SortOrder order)
Adds a sort against the given field name and the sort ordering.
|
TopHitsBuilder |
TopHitsBuilder.setExplain(boolean explain)
Should each
SearchHit be returned with an
explanation of the hit (ranking). |
TopHitsBuilder |
TopHitsBuilder.setFetchSource(boolean fetch)
Indicates whether the response should contain the stored _source for every hit
|
TopHitsBuilder |
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 |
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 |
TopHitsBuilder.setFrom(int from)
The index to start to return hits from.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterBoundaryChars(char[] boundaryChars) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterBoundaryMaxScan(Integer boundaryMaxScan) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterEncoder(String encoder)
The encoder to set for highlighting
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterFilter(Boolean highlightFilter) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterFragmenter(String fragmenter) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterFragmentSize(Integer fragmentSize) |
TopHitsBuilder |
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 |
TopHitsBuilder.setHighlighterNumOfFragments(Integer numOfFragments) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterOptions(Map<String,Object> options) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterOrder(String order)
The order of fragments per field.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterPhraseLimit(Integer phraseLimit)
Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterPostTags(String... postTags)
Explicitly set the post tags that will be used for highlighting.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterPreTags(String... preTags)
Explicitly set the pre tags that will be used for highlighting.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterQuery(QueryBuilder highlightQuery)
Sets a query to be used for highlighting all fields instead of the search query.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterRequireFieldMatch(boolean requireFieldMatch) |
TopHitsBuilder |
TopHitsBuilder.setHighlighterTagsSchema(String schemaName)
Set a tag scheme that encapsulates a built in pre and post tags.
|
TopHitsBuilder |
TopHitsBuilder.setHighlighterType(String type)
The highlighter type to use.
|
TopHitsBuilder |
TopHitsBuilder.setNoFields()
Sets no fields to be loaded, resulting in only id and type to be returned per field.
|
TopHitsBuilder |
TopHitsBuilder.setSize(int size)
The number of search hits to return.
|
TopHitsBuilder |
TopHitsBuilder.setTrackScores(boolean trackScores)
Applies when sorting, and controls if scores will be tracked as well.
|
TopHitsBuilder |
TopHitsBuilder.setVersion(boolean version)
Should each
SearchHit be returned with its
version. |
Copyright © 2009–2015. All rights reserved.