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

Class AbstractSearchQuery<H,R extends SearchResult<H>>

java.lang.Object

org.hibernate.search.engine.search.query.spi.AbstractSearchQuery<H,R>

Type Parameters:

H - The type of query hits.

R - The result type (extending SearchResult).

All Implemented Interfaces:

SearchFetchable<H>, SearchQuery<H>, SearchQueryImplementor<H>

public abstract class AbstractSearchQuery<H,R extends SearchResult<H>>
extends Object
implements SearchQueryImplementor<H>

An abstract base for implementations of SearchQuery.

Constructor Summary

Constructors

Constructor	Description
AbstractSearchQuery()

Method Summary

Modifier and Type	Method	Description
R	fetch(Integer limit)	Execute the query and return the SearchResult, limiting to limit hits.
abstract 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.
List<H>	fetchAllHits()	Execute the query and return all hits as a List, without any sort of limit.
List<H>	fetchHits(Integer limit)	Execute the query and return the hits as a List, limiting to limit hits.
Optional<H>	fetchSingleHit()	Execute the query and return the hits as a single, optional element.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

fetchHits, fetchTotalHitCount, scroll

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

extension, queryString

Methods inherited from interface org.hibernate.search.engine.search.query.spi.SearchQueryImplementor

failAfter

Constructor Detail

AbstractSearchQuery

public AbstractSearchQuery()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

fetchAll

public 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.

fetch

public 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

public abstract 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.

fetchAllHits

public List<H> fetchAllHits()

Description copied from interface: SearchFetchable

Execute the query and return all hits as a List, without any sort of limit.

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

Specified by:

fetchAllHits in interface SearchFetchable<H>

Returns:

The query hits.

fetchHits

public List<H> fetchHits(Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the hits as a List, limiting to limit hits.

Specified by:

fetchHits in interface SearchFetchable<H>

Parameters:

limit - The maximum number of hits to be returned by this method. null means no limit.

Returns:

The query hits.

fetchSingleHit

public Optional<H> fetchSingleHit()

Description copied from interface: SearchFetchable

Execute the query and return the hits as a single, optional element.

Specified by:

fetchSingleHit in interface SearchFetchable<H>

Returns:

The single, optional query hit.