Interface CountValuesAggregationOptionsStep<SR,S extends CountValuesAggregationOptionsStep<SR,?,PDF>,PDF extends TypedSearchPredicateFactory<SR>>

Type Parameters:
SR - Scope root type.
S - The "self" type (the actual exposed type of this step).
PDF - The type of factory used to create predicates in AggregationFilterStep.filter(Function).
All Superinterfaces:
AggregationFilterStep<SR,S,PDF>, AggregationFinalStep<Long>

@Incubating public interface CountValuesAggregationOptionsStep<SR,S extends CountValuesAggregationOptionsStep<SR,?,PDF>,PDF extends TypedSearchPredicateFactory<SR>> extends AggregationFinalStep<Long>, AggregationFilterStep<SR,S,PDF>
The final step in a "count" aggregation definition, where optional parameters can be set.
  • Method Summary

    Modifier and Type
    Method
    Description
    default S
    Count only distinct field values.
    distinct(boolean distinct)
    Specify whether to count distinct or all field values.

    Methods inherited from interface org.hibernate.search.engine.search.aggregation.dsl.AggregationFilterStep

    filter, filter, filter

    Methods inherited from interface org.hibernate.search.engine.search.aggregation.dsl.AggregationFinalStep

    toAggregation
  • Method Details

    • distinct

      default S distinct()
      Count only distinct field values.
      Returns:
      The next step.
    • distinct

      S distinct(boolean distinct)
      Specify whether to count distinct or all field values.
      Parameters:
      distinct - Use true if only distinct field values should be counted, false otherwise.
      Returns:
      The next step.