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

Interface ExtendedSearchFetchable<H,R extends SearchResult<H>,SC extends SearchScroll<H>>

Type Parameters:

H - The type of query hits.

R - The result type (extending SearchResult).

SC - The scroll type (extending SearchScroll).

All Superinterfaces:

SearchFetchable<H>

All Known Subinterfaces:

ElasticsearchSearchFetchable<H>, ElasticsearchSearchQuery<H>, ElasticsearchSearchQueryOptionsStep<H,LOS>, ExtendedSearchQuery<H,R,SC>, LuceneSearchFetchable<H>, LuceneSearchQuery<H>, LuceneSearchQueryOptionsStep<H,LOS>

public interface ExtendedSearchFetchable<H,R extends SearchResult<H>,SC extends SearchScroll<H>>
extends SearchFetchable<H>

A base interface for subtypes of SearchFetchable allowing to easily override the result type for all relevant methods.

Method Summary

Modifier and Type	Method	Description
R	fetch(Integer limit)	Execute the query and return the SearchResult, limiting to limit hits.
R	fetch(Integer offset, Integer limit)	Execute the query and return the SearchResult, skipping offset hits and limiting to limit hits.
R	fetchAll()	Execute the query and return the SearchResult, including all hits, without any sort of limit.
SC	scroll(int chunkSize)	Execute the query continuously to deliver results in small chunks through a SearchScroll.

Methods inherited from interface org.hibernate.search.engine.search.query.SearchFetchable

fetchAllHits, fetchHits, fetchHits, fetchSingleHit, fetchTotalHitCount

Method Details

fetch

R fetch(Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the SearchResult, limiting to limit hits.

Specified by:

fetch in interface SearchFetchable<H>

Parameters:

limit - The maximum number of hits to be included in the SearchResult. null means no limit.

Returns:

The SearchResult.

fetch

R fetch(Integer offset,
 Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the SearchResult, skipping offset hits and limiting to limit hits.

Specified by:

fetch in interface SearchFetchable<H>

Parameters:

offset - The number of hits to skip before adding the hits to the SearchResult. null means no offset.

limit - The maximum number of hits to be included in the SearchResult. null means no limit.

Returns:

The SearchResult.

fetchAll

R fetchAll()

Description copied from interface: SearchFetchable

Execute the query and return the SearchResult, including all hits, without any sort of limit.

SearchFetchable.fetch(Integer) or SearchFetchable.fetch(Integer, Integer) should generally be preferred, for performance reasons.

Specified by:

fetchAll in interface SearchFetchable<H>

Returns:

The SearchResult.

scroll

SC scroll(int chunkSize)

Description copied from interface: SearchFetchable

Execute the query continuously to deliver results in small chunks through a SearchScroll.

Useful to process large datasets.

Specified by:

scroll in interface SearchFetchable<H>

Parameters:

chunkSize - The maximum number of hits to be returned for each call to SearchScroll.next()

Returns:

The SearchScroll.