Package org.hibernate.search.engine.search.aggregation.dsl

Interface CountAggregationKindStep<SR,PDF extends TypedSearchPredicateFactory<SR>>

Type Parameters:

SR - Scope root type.

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

@Incubating
public interface CountAggregationKindStep<SR,PDF extends TypedSearchPredicateFactory<SR>>

The initial step in a "count" aggregation definition, where the kind of the aggregation can be picked.

Method Summary

Modifier and Type	Method	Description
CountDocumentsAggregationFinalStep	documents()	Count documents that match the query.
CountValuesAggregationOptionsStep<SR,?,PDF>	field(String fieldPath)	Count the number of non-empty values for the given field.
default CountValuesAggregationOptionsStep<SR,?,PDF>	field(CountAggregationFieldReference<SR> fieldReference)	Count the number of non-empty values for the given field.

Method Details

documents

@Incubating
CountDocumentsAggregationFinalStep documents()

Count documents that match the query.

This aggregation may be useful for building SearchAggregationFactory.range() or SearchAggregationFactory.terms() aggregations.

Returns:

The next step.

field

@Incubating
CountValuesAggregationOptionsStep<SR,?,PDF> field(String fieldPath)

Count the number of non-empty values for the given field.

For a multi-valued field, the resulting count may be greater than the number of matched documents.

Parameters:

fieldPath - The path to the index field to aggregate.

Returns:

The next step.

field

@Incubating
default CountValuesAggregationOptionsStep<SR,?,PDF> field(CountAggregationFieldReference<SR> fieldReference)

Count the number of non-empty values for the given field.

For a multi-valued field, the resulting count may be greater than the number of matched documents.

Parameters:

fieldReference - The field reference representing a definition of the index field to aggregate.

Returns:

The next step.