Package org.hibernate.search.engine.search.query

Interface SearchResult<H>

  • Type Parameters:
    H - The type of hits.
    All Known Implementing Classes:
    SimpleSearchResult
    public interface SearchResult<H>

    • Method Detail

      • total

        SearchResultTotal total()
        Returns:
        The total for a search result, pertaining to all matched documents, independently from the offset/limit used when fetching hits. Includes in particular the total hit count.

      • hits

        List<H> hits()
        Returns:
        The hits as a List containing one element for each matched entity.

      • getHits

        @Deprecated
default List<H> getHits()
        Deprecated.
        Use hits() instead.
        Returns:
        The hits as a List containing one element for each matched entity.

      • aggregation

        <A> A aggregation​(AggregationKey<A> key)
        Type Parameters:
        A - The type of result for this aggregation.
        Parameters:
        key - The key previously used to register the aggregation during query building.
        Returns:
        The result for the given aggregation.
        Throws:
        SearchException - If the given key was never registered while building this query, and is thus not mapped to anything.

      • getAggregation

        @Deprecated
default <A> A getAggregation​(AggregationKey<A> key)
        Deprecated.
        Use aggregation(AggregationKey) instead.
        Type Parameters:
        A - The type of result for this aggregation.
        Parameters:
        key - The key previously used to register the aggregation during query building.
        Returns:
        The result for the given aggregation.
        Throws:
        SearchException - If the given key was never registered while building this query, and is thus not mapped to anything.

      • took

        Duration took()
        Returns:
        the time taken to process the request, as a Duration

      • timedOut

        boolean timedOut()
        Returns:
        whether or not a timeout occurred processing the request.

      • isTimedOut

        @Deprecated
default boolean isTimedOut()
        Deprecated.
        Use timedOut() instead.
        Returns:
        whether or not a timeout occurred processing the request.