Package io.vanslog.spring.data.meilisearch.core

Interface SearchHits<T>

All Superinterfaces:

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

All Known Implementing Classes:

SearchHitsImpl

public interface SearchHits<T>
extends Streamable<SearchHit<T>>

Method Summary

Modifier and Type	Method	Description
Duration	getExecutionDuration()
SearchHit<T>	getSearchHit(int index)
List<SearchHit<T>>	getSearchHits()
default long	getTotalHits()
default TotalHitsRelation	getTotalHitsRelation()
default boolean	hasSearchHits()
default Iterator<SearchHit<T>>	iterator()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

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

Method Details

hasSearchHits

default boolean hasSearchHits()

Returns:

whether the SearchHits has search hits.

getExecutionDuration

Duration getExecutionDuration()

Returns:

the execution duration it took to complete the request

getSearchHit

SearchHit<T> getSearchHit(int index)

Parameters:

index - position in List.

Returns:

the SearchHit at position {index}

Throws:

IndexOutOfBoundsException - on invalid index

getSearchHits

List<SearchHit<T>> getSearchHits()

Returns:

the contained SearchHits.

getTotalHits

default long getTotalHits()

Returns:

the reported total-hit metadata only when getTotalHitsRelation() is TotalHitsRelation.EQUAL_TO; otherwise the loaded hit count, which is not usable as a page total.

getTotalHitsRelation

default TotalHitsRelation getTotalHitsRelation()

Returns:

how getTotalHits() relates to the reported total-hit metadata. Only TotalHitsRelation.EQUAL_TO marks total-hit metadata reported by the search response.

iterator

default Iterator<SearchHit<T>> iterator()

Specified by:

iterator in interface Iterable<T>