Package org.springframework.data.elasticsearch.core

Interface SearchHitsIterator<T>

Type Parameters:

T -

All Superinterfaces:

AutoCloseable, Closeable, CloseableIterator<SearchHit<T>>, Iterator<SearchHit<T>>

public interface SearchHitsIterator<T>
extends CloseableIterator<SearchHit<T>>

A SearchHitsIterator encapsulates SearchHit results that can be wrapped in a Java 8 Stream.

Since:

4.0

Author:

Sascha Woo

Method Summary

Modifier and Type	Method	Description
AggregationsContainer<?>	getAggregations()
float	getMaxScore()
long	getTotalHits()
TotalHitsRelation	getTotalHitsRelation()
default boolean	hasAggregations()

Methods inherited from interface org.springframework.data.util.CloseableIterator

close, spliterator, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Details

getAggregations

@Nullable
AggregationsContainer<?> getAggregations()

Returns:

the aggregations.

getMaxScore

float getMaxScore()

Returns:

the maximum score

getTotalHits

long getTotalHits()

Returns:

the number of total hits.

getTotalHitsRelation

TotalHitsRelation getTotalHitsRelation()

Returns:

the relation for the total hits

hasAggregations

default boolean hasAggregations()

Returns:

true if aggregations are available