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

Interface SearchQueryBuilder<H>

Type Parameters:

H - The type of query results

All Known Implementing Classes:

ElasticsearchSearchQueryBuilder, LuceneSearchQueryBuilder

public interface SearchQueryBuilder<H>

A builder for search queries.

Method Summary

Modifier and Type	Method	Description
void	addRoutingKey(String routingKey)
<A> void	aggregation(AggregationKey<A> key, SearchAggregation<A> aggregation)
SearchQuery<H>	build()
void	failAfter(long timeout, TimeUnit timeUnit)
void	highlighter(String highlighterName, SearchHighlighter highlighter)
void	highlighter(SearchHighlighter queryHighlighter)
void	predicate(SearchPredicate predicate)
void	sort(SearchSort sort)
void	totalHitCountThreshold(long totalHitCountThreshold)
void	truncateAfter(long timeout, TimeUnit timeUnit)

Method Detail

predicate

void predicate(SearchPredicate predicate)

sort

void sort(SearchSort sort)

aggregation

<A> void aggregation(AggregationKey<A> key,
                     SearchAggregation<A> aggregation)

addRoutingKey

void addRoutingKey(String routingKey)

truncateAfter

void truncateAfter(long timeout,
                   TimeUnit timeUnit)

failAfter

void failAfter(long timeout,
               TimeUnit timeUnit)

totalHitCountThreshold

void totalHitCountThreshold(long totalHitCountThreshold)

highlighter

@Incubating
void highlighter(SearchHighlighter queryHighlighter)

highlighter

@Incubating
void highlighter(String highlighterName,
                 SearchHighlighter highlighter)

build

SearchQuery<H> build()