ExtendedSearchAggregationFactory (Hibernate Search 6.0.11.Final)

Type Parameters:

PDF - The type of factory used to create predicates in AggregationFilterStep.filter(Function).

All Superinterfaces:

SearchAggregationFactory

All Known Subinterfaces:

ElasticsearchSearchAggregationFactory, LuceneSearchAggregationFactory

All Known Implementing Classes:

DelegatingSearchAggregationFactory
```
public interface ExtendedSearchAggregationFactory<PDF extends SearchPredicateFactory>
extends SearchAggregationFactory
```
A base interface for subtypes of SearchAggregationFactory allowing to easily override the predicate factory type for all relevant methods.
Warning: Generic parameters of this type are subject to change, so this type should not be referenced directtly in user code.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RangeAggregationFieldStep<PDF>`	`range()`	Perform aggregation in range buckets.
`TermsAggregationFieldStep<PDF>`	`terms()`	Perform aggregation in term buckets.

Methods inherited from interface org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactory
extension

- Method Detail
  - range
```
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 SearchAggregationFactory
    
    Returns:
    
    The next step.
  - terms
```
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 SearchAggregationFactory
    
    Returns:
    
    The next step.