Class SearchHitsImpl<T>

java.lang.Object

org.springframework.data.elasticsearch.core.SearchHitsImpl<T>

Type Parameters:

T - the result data class.

All Implemented Interfaces:

Iterable<SearchHit<T>>, Supplier<Stream<SearchHit<T>>>, SearchHits<T>, SearchScrollHits<T>, Streamable<SearchHit<T>>

public class SearchHitsImpl<T>
extends Object
implements SearchScrollHits<T>

Basic implementation of SearchScrollHits

Since:

4.0

Author:

Peter-Josef Meisch, Sascha Woo, Haibo Liu, Mohamed El Harrougui

Constructor Summary

Constructors

Constructor	Description
SearchHitsImpl(long totalHits, TotalHitsRelation totalHitsRelation, float maxScore, Duration executionDuration, @Nullable String scrollId, @Nullable String pointInTimeId, List<? extends SearchHit<T>> searchHits, @Nullable AggregationsContainer<?> aggregations, @Nullable Suggest suggest, @Nullable SearchShardStatistics searchShardStatistics)

Method Summary

Modifier and Type	Method	Description
@Nullable AggregationsContainer<?>	getAggregations()
Duration	getExecutionDuration()
float	getMaxScore()
@Nullable String	getPointInTimeId()	When doing a search with a point in time, the response contains a new point in time id value.
@Nullable String	getScrollId()
SearchHit<T>	getSearchHit(int index)
List<SearchHit<T>>	getSearchHits()
SearchShardStatistics	getSearchShardStatistics()
@Nullable Suggest	getSuggest()
long	getTotalHits()
TotalHitsRelation	getTotalHitsRelation()
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface SearchHits

hasAggregations, hasSearchHits, hasSuggest, iterator

Methods inherited from interface Streamable

and, and, and, and, filter, flatMap, get, isEmpty, map, stream, toList, toSet

Constructor Details

SearchHitsImpl

public SearchHitsImpl(long totalHits,
 TotalHitsRelation totalHitsRelation,
 float maxScore,
 Duration executionDuration,
 @Nullable String scrollId,
 @Nullable String pointInTimeId,
 List<? extends SearchHit<T>> searchHits,
 @Nullable AggregationsContainer<?> aggregations,
 @Nullable Suggest suggest,
 @Nullable SearchShardStatistics searchShardStatistics)

Parameters:

totalHits - the number of total hits for the search

totalHitsRelation - the relation , must not be null

maxScore - the maximum score

executionDuration - the execution duration it took to complete the request

scrollId - the scroll id if available

searchHits - must not be null

aggregations - the aggregations if available

Method Details

getTotalHits

public long getTotalHits()

Specified by:

getTotalHits in interface SearchHits<T>

Returns:

the number of total hits.

getTotalHitsRelation

public TotalHitsRelation getTotalHitsRelation()

Specified by:

getTotalHitsRelation in interface SearchHits<T>

Returns:

the relation for the total hits

getMaxScore

public float getMaxScore()

Specified by:

getMaxScore in interface SearchHits<T>

Returns:

the maximum score

getExecutionDuration

public Duration getExecutionDuration()

Specified by:

getExecutionDuration in interface SearchHits<T>

Returns:

the execution duration it took to complete the request

getScrollId

public @Nullable String getScrollId()

Specified by:

getScrollId in interface SearchScrollHits<T>

Returns:

the scroll id

getSearchHits

public List<SearchHit<T>> getSearchHits()

Specified by:

getSearchHits in interface SearchHits<T>

Returns:

the contained SearchHits.

getSearchHit

public SearchHit<T> getSearchHit(int index)

Specified by:

getSearchHit in interface SearchHits<T>

Parameters:

index - position in List.

Returns:

the SearchHit at position {index}

getAggregations

public @Nullable AggregationsContainer<?> getAggregations()

Specified by:

getAggregations in interface SearchHits<T>

Returns:

the aggregations.

getSuggest

public @Nullable Suggest getSuggest()

Specified by:

getSuggest in interface SearchHits<T>

Returns:

the suggest response

getPointInTimeId

public @Nullable String getPointInTimeId()

Description copied from interface: SearchHits

When doing a search with a point in time, the response contains a new point in time id value.

Specified by:

getPointInTimeId in interface SearchHits<T>

Returns:

the new point in time id, if one was returned from Elasticsearch

getSearchShardStatistics

public SearchShardStatistics getSearchShardStatistics()

Specified by:

getSearchShardStatistics in interface SearchHits<T>

Returns:

shard statistics for the search hit.

toString

public String toString()

Overrides:

toString in class Object