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

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

Type Parameters:

SR - Scope root type.

S - The self type, i.e. the exposed type of this factory.

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

All Superinterfaces:

SearchAggregationFactory, TypedSearchAggregationFactory<SR>

All Known Implementing Classes:

AbstractSearchAggregationFactory

public interface ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,?,PDF>,PDF extends TypedSearchPredicateFactory<SR>>
extends TypedSearchAggregationFactory<SR>

A base interface for subtypes of TypedSearchAggregationFactory allowing to easily override the self type and predicate factory type for all relevant methods.

Warning: Generic parameters of this type are subject to change, so this type should not be referenced directly in user code.

Method Summary

Modifier and Type	Method	Description
AvgAggregationFieldStep<SR,PDF>	avg()	Perform the avg metric aggregation.
CountAggregationKindStep<SR,PDF>	count()	Perform the count metric aggregation.
CountDistinctValuesAggregationFieldStep<SR,PDF>	countDistinct()	Deprecated, for removal: This API element is subject to removal in a future version.
MaxAggregationFieldStep<SR,PDF>	max()	Perform the max metric aggregation.
MinAggregationFieldStep<SR,PDF>	min()	Perform the min metric aggregation.
RangeAggregationFieldStep<SR,PDF>	range()	Perform aggregation in range buckets.
SumAggregationFieldStep<SR,PDF>	sum()	Perform the sum metric aggregation.
TermsAggregationFieldStep<SR,PDF>	terms()	Perform aggregation in term buckets.
S	withRoot(String objectFieldPath)	Create a new aggregation factory whose root for all paths passed to the DSL will be the given object field.

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

composite, composite, composite, extension, toAbsolutePath, withParameters

Method Details

withRoot

S withRoot(String objectFieldPath)

Description copied from interface: TypedSearchAggregationFactory

Create a new aggregation factory whose root for all paths passed to the DSL will be the given object field.

See here for more information.

Specified by:

withRoot in interface SearchAggregationFactory

Specified by:

withRoot in interface TypedSearchAggregationFactory<SR>

Parameters:

objectFieldPath - The path from the current root to an object field that will become the new root.

Returns:

A new aggregation factory using the given object field as root.

range

RangeAggregationFieldStep<SR,PDF> range()

Description copied from interface: TypedSearchAggregationFactory

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

Specified by:

range in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

terms

TermsAggregationFieldStep<SR,PDF> terms()

Description copied from interface: TypedSearchAggregationFactory

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

Specified by:

terms in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

sum

SumAggregationFieldStep<SR,PDF> sum()

Description copied from interface: TypedSearchAggregationFactory

Perform the sum metric aggregation.

Sums up the field values.

Specified by:

sum in interface SearchAggregationFactory

Specified by:

sum in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

min

MinAggregationFieldStep<SR,PDF> min()

Description copied from interface: TypedSearchAggregationFactory

Perform the min metric aggregation.

Provides the minimum value among the field values.

Specified by:

min in interface SearchAggregationFactory

Specified by:

min in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

max

MaxAggregationFieldStep<SR,PDF> max()

Description copied from interface: TypedSearchAggregationFactory

Perform the max metric aggregation.

Provides the maximum value among the field values.

Specified by:

max in interface SearchAggregationFactory

Specified by:

max in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

count

@Incubating
CountAggregationKindStep<SR,PDF> count()

Description copied from interface: TypedSearchAggregationFactory

Perform the count metric aggregation.

The following steps allow defining the kind of the count aggregation: count documents or count values.

Specified by:

count in interface SearchAggregationFactory

Specified by:

count in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

countDistinct

@Deprecated(since="8.1",
            forRemoval=true)
CountDistinctValuesAggregationFieldStep<SR,PDF> countDistinct()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: TypedSearchAggregationFactory

Perform the count distinct values metric aggregation.

Counts the number of unique field values.

Specified by:

countDistinct in interface SearchAggregationFactory

Specified by:

countDistinct in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

avg

AvgAggregationFieldStep<SR,PDF> avg()

Description copied from interface: TypedSearchAggregationFactory

Perform the avg metric aggregation.

Calculates the average value of a given numeric or temporal field among the matched documents.

Specified by:

avg in interface SearchAggregationFactory

Specified by:

avg in interface TypedSearchAggregationFactory<SR>

Returns:

the next step.