org.hibernate.search.engine.search.aggregation.dsl.spi

Class DelegatingSearchAggregationFactory<PDF extends SearchPredicateFactory>

java.lang.Object

org.hibernate.search.engine.search.aggregation.dsl.spi.DelegatingSearchAggregationFactory<PDF>

All Implemented Interfaces:

ExtendedSearchAggregationFactory<PDF>, SearchAggregationFactory

public class DelegatingSearchAggregationFactory<PDF extends SearchPredicateFactory>
extends Object
implements ExtendedSearchAggregationFactory<PDF>

A delegating SearchAggregationFactory.

Mainly useful when implementing a SearchAggregationFactoryExtension.

Constructor Summary

Constructors

Constructor and Description
DelegatingSearchAggregationFactory(SearchAggregationFactory delegate, SearchAggregationDslContext<?,? extends PDF> dslContext)

Method Summary

Modifier and Type	Method and Description
<T> T	extension(SearchAggregationFactoryExtension<T> extension) Extend the current factory with the given extension, resulting in an extended factory offering different types of aggregations.
protected SearchAggregationFactory	getDelegate()
RangeAggregationFieldStep<PDF>	range() Perform aggregation in range buckets.
TermsAggregationFieldStep<PDF>	terms() Perform aggregation in term buckets.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingSearchAggregationFactory

public DelegatingSearchAggregationFactory(SearchAggregationFactory delegate,
                                          SearchAggregationDslContext<?,? extends PDF> dslContext)

Method Detail

range

public RangeAggregationFieldStep<PDF> range()

Description copied from interface: SearchAggregationFactory

Perform aggregation in range buckets.

Given a field and one or more ranges of values, this aggregation creates one bucket per range, and puts in each bucket every document for which the given field has a value that falls into the corresponding range.

For each bucket, the document count is computed, or more complex metrics or sub-aggregations for backends that support it.

Specified by:

range in interface ExtendedSearchAggregationFactory<PDF extends SearchPredicateFactory>

Specified by:

range in interface SearchAggregationFactory

Returns:

The next step.

terms

public TermsAggregationFieldStep<PDF> terms()

Description copied from interface: SearchAggregationFactory

Perform aggregation in term buckets.

Given a field, this aggregation creates one bucket per term of that field in the index, and puts in each bucket every document for which the given field matches the corresponding term.

For each bucket, the document count is computed, or more complex metrics or sub-aggregations for backends that support it.

Specified by:

terms in interface ExtendedSearchAggregationFactory<PDF extends SearchPredicateFactory>

Specified by:

terms in interface SearchAggregationFactory

Returns:

The next step.

extension

public <T> T extension(SearchAggregationFactoryExtension<T> extension)

Description copied from interface: SearchAggregationFactory

Extend the current factory with the given extension, resulting in an extended factory offering different types of aggregations.

Specified by:

extension in interface SearchAggregationFactory

Type Parameters:

T - The type of factory provided by the extension.

Parameters:

extension - The extension to the aggregation DSL.

Returns:

The extended factory.

getDelegate

protected SearchAggregationFactory getDelegate()