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

Class SearchHitsImpl<T>

java.lang.Object

io.vanslog.spring.data.meilisearch.core.SearchHitsImpl<T>

All Implemented Interfaces:

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

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

Constructor Summary

Constructors

Constructor	Description
SearchHitsImpl(Duration executionDuration, List<? extends SearchHit<T>> searchHits)
SearchHitsImpl(Duration executionDuration, List<? extends SearchHit<T>> searchHits, long totalHits, TotalHitsRelation totalHitsRelation)

Method Summary

Modifier and Type	Method	Description
Duration	getExecutionDuration()
SearchHit<T>	getSearchHit(int index)
List<SearchHit<T>>	getSearchHits()
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 io.vanslog.spring.data.meilisearch.core.SearchHits

hasSearchHits, 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(Duration executionDuration,
 List<? extends SearchHit<T>> searchHits)

SearchHitsImpl

public SearchHitsImpl(Duration executionDuration,
 List<? extends SearchHit<T>> searchHits,
 long totalHits,
 TotalHitsRelation totalHitsRelation)

Method Details

getExecutionDuration

public Duration getExecutionDuration()

Specified by:

getExecutionDuration in interface SearchHits<T>

Returns:

the execution duration it took to complete the request

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}

getSearchHits

public List<SearchHit<T>> getSearchHits()

Specified by:

getSearchHits in interface SearchHits<T>

Returns:

the contained SearchHits.

getTotalHits

public long getTotalHits()

Specified by:

getTotalHits in interface SearchHits<T>

Returns:

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

getTotalHitsRelation

public TotalHitsRelation getTotalHitsRelation()

Specified by:

getTotalHitsRelation in interface SearchHits<T>

Returns:

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

toString

public String toString()

Overrides:

toString in class Object