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

Interface TypedSearchAggregationFactory<SR>

Type Parameters:

SR - Scope root type.

All Superinterfaces:

SearchAggregationFactory

All Known Subinterfaces:

ElasticsearchSearchAggregationFactory<SR>, ExtendedSearchAggregationFactory<SR,S,PDF>, LuceneSearchAggregationFactory<SR>

All Known Implementing Classes:

AbstractSearchAggregationFactory

public interface TypedSearchAggregationFactory<SR>
extends SearchAggregationFactory

A factory for search aggregations.

Field paths

By default, field paths passed to this DSL are interpreted as absolute, i.e. relative to the index root.

However, a new, "relative" factory can be created with withRoot(String): the new factory interprets paths as relative to the object field passed as argument to the method.

This can be useful when calling reusable methods that can apply the same aggregation on different object fields that have same structure (same sub-fields).

Such a factory can also transform relative paths into absolute paths using SearchAggregationFactory.toAbsolutePath(String); this can be useful for native aggregations in particular.

Field references

A field reference is always represented by the absolute field path and, if applicable, i.e. when a field reference is typed, a combination of the ValueModel and the type.

Field references are usually accessed from the generated Hibernate Search's static metamodel classes that describe the index structure. Such reference provides the information on which search capabilities the particular index field possesses, and allows switching between different value model representations.

Author:

Emmanuel Bernard emmanuel@hibernate.org

Method Summary

Modifier and Type	Method	Description
AvgAggregationFieldStep<SR,?>	avg()	Perform the avg metric aggregation.
CountAggregationFieldStep<SR,?>	count()	Perform the count metric aggregation.
CountDistinctAggregationFieldStep<SR,?>	countDistinct()	Perform the count distinct metric aggregation.
MaxAggregationFieldStep<SR,?>	max()	Perform the max metric aggregation.
MinAggregationFieldStep<SR,?>	min()	Perform the min metric aggregation.
RangeAggregationFieldStep<SR,?>	range()	Perform aggregation in range buckets.
SumAggregationFieldStep<SR,?>	sum()	Perform the sum metric aggregation.
TermsAggregationFieldStep<SR,?>	terms()	Perform aggregation in term buckets.
TypedSearchAggregationFactory<SR>	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

extension, toAbsolutePath, withParameters

Method Details

range

RangeAggregationFieldStep<SR,?> range()

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<SR,?> terms()

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.

sum

@Incubating
SumAggregationFieldStep<SR,?> sum()

Perform the sum metric aggregation.

Specified by:

sum in interface SearchAggregationFactory

Returns:

The next step.

min

@Incubating
MinAggregationFieldStep<SR,?> min()

Perform the min metric aggregation.

Specified by:

min in interface SearchAggregationFactory

Returns:

The next step.

max

@Incubating
MaxAggregationFieldStep<SR,?> max()

Perform the max metric aggregation.

Specified by:

max in interface SearchAggregationFactory

Returns:

The next step.

count

@Incubating
CountAggregationFieldStep<SR,?> count()

Perform the count metric aggregation.

Specified by:

count in interface SearchAggregationFactory

Returns:

The next step.

countDistinct

@Incubating
CountDistinctAggregationFieldStep<SR,?> countDistinct()

Perform the count distinct metric aggregation.

Specified by:

countDistinct in interface SearchAggregationFactory

Returns:

The next step.

avg

@Incubating
AvgAggregationFieldStep<SR,?> avg()

Perform the avg metric aggregation.

Specified by:

avg in interface SearchAggregationFactory

Returns:

the next step.

withRoot

@Incubating
TypedSearchAggregationFactory<SR> withRoot(String objectFieldPath)

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

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.