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>>
Basic implementation of
SearchScrollHits
- Since:
- 4.0
- Author:
- Peter-Josef Meisch, Sascha Woo
-
Constructor Summary
ConstructorDescriptionSearchHitsImpl
(long totalHits, TotalHitsRelation totalHitsRelation, float maxScore, String scrollId, String pointInTimeId, List<? extends SearchHit<T>> searchHits, AggregationsContainer<?> aggregations, Suggest suggest) -
Method Summary
Modifier and TypeMethodDescriptionfloat
When doing a search with a point in time, the response contains a new point in time id value.getSearchHit
(int index) long
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
-
Constructor Details
-
SearchHitsImpl
public SearchHitsImpl(long totalHits, TotalHitsRelation totalHitsRelation, float maxScore, @Nullable String scrollId, @Nullable String pointInTimeId, List<? extends SearchHit<T>> searchHits, @Nullable AggregationsContainer<?> aggregations, @Nullable Suggest suggest) - Parameters:
totalHits
- the number of total hits for the searchtotalHitsRelation
- the relation , must not be nullmaxScore
- the maximum scorescrollId
- the scroll id if availablesearchHits
- must not be nullaggregations
- the aggregations if available
-
-
Method Details
-
getTotalHits
public long getTotalHits()- Specified by:
getTotalHits
in interfaceSearchHits<T>
- Returns:
- the number of total hits.
-
getTotalHitsRelation
- Specified by:
getTotalHitsRelation
in interfaceSearchHits<T>
- Returns:
- the relation for the total hits
-
getMaxScore
public float getMaxScore()- Specified by:
getMaxScore
in interfaceSearchHits<T>
- Returns:
- the maximum score
-
getScrollId
- Specified by:
getScrollId
in interfaceSearchScrollHits<T>
- Returns:
- the scroll id
-
getSearchHits
- Specified by:
getSearchHits
in interfaceSearchHits<T>
- Returns:
- the contained
SearchHit
s.
-
getSearchHit
- Specified by:
getSearchHit
in interfaceSearchHits<T>
- Parameters:
index
- position in List.- Returns:
- the
SearchHit
at position {index}
-
getAggregations
- Specified by:
getAggregations
in interfaceSearchHits<T>
- Returns:
- the aggregations.
-
getSuggest
- Specified by:
getSuggest
in interfaceSearchHits<T>
- Returns:
- the suggest response
-
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 interfaceSearchHits<T>
- Returns:
- the new point in time id, if one was returned from Elasticsearch
-
toString
-