Module spring.data.elasticsearch

Package org.springframework.data.elasticsearch.core

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, String scrollId, String pointInTimeId, List<? extends SearchHit<T>> searchHits, AggregationsContainer<?> aggregations, Suggest suggest, SearchShardStatistics searchShardStatistics)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchHits

hasAggregations, hasSearchHits, hasSuggest, iterator

Methods inherited from interface org.springframework.data.util.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

@Nullable
public 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

@Nullable
public AggregationsContainer<?> getAggregations()

Specified by:

getAggregations in interface SearchHits<T>

Returns:

the aggregations.

getSuggest

@Nullable
public Suggest getSuggest()

Specified by:

getSuggest in interface SearchHits<T>

Returns:

the suggest response

getPointInTimeId

@Nullable
public 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