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

Class AbstractSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>,PDF extends TypedSearchPredicateFactory<SR>>

java.lang.Object

org.hibernate.search.engine.search.aggregation.dsl.spi.AbstractSearchAggregationFactory<SR,S,SC,PDF>

All Implemented Interfaces:

ExtendedSearchAggregationFactory<SR,S,PDF>, SearchAggregationFactory, TypedSearchAggregationFactory<SR>

public abstract class AbstractSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>,PDF extends TypedSearchPredicateFactory<SR>>
extends Object
implements ExtendedSearchAggregationFactory<SR,S,PDF>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SearchAggregationDslContext<SR,SC,PDF>	dslContext

Constructor Summary

Constructors

Constructor	Description
AbstractSearchAggregationFactory(SearchAggregationDslContext<SR,SC,PDF> dslContext)

Method Summary

Modifier and Type	Method	Description
AvgAggregationFieldStep<SR,PDF>	avg()	Perform the avg metric aggregation.
CompositeAggregationInnerStep	composite()	Starts the definition of a composite aggregation, which will combine multiple given aggregations.
AggregationFinalStep<List<?>>	composite(SearchAggregation<?>... aggregations)	Create an aggregation that will compose a List based on the given aggregations.
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.
<T> T	extension(SearchAggregationFactoryExtension<T> extension)	Extend the current factory with the given extension, resulting in an extended factory offering different types of aggregations.
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.
final String	toAbsolutePath(String relativeFieldPath)
<T> AggregationFinalStep<T>	withParameters(Function<? super NamedValues,? extends AggregationFinalStep<T>> aggregationCreator)	Delegating aggregation that creates the actual aggregation at query create time and provides access to query parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

withRoot

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

composite

Field Details

dslContext

protected final SearchAggregationDslContext<SR,SC extends SearchAggregationIndexScope<?>,PDF extends TypedSearchPredicateFactory<SR>> dslContext

Constructor Details

AbstractSearchAggregationFactory

public AbstractSearchAggregationFactory(SearchAggregationDslContext<SR,SC,PDF> dslContext)

Method Details

range

public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

range in interface SearchAggregationFactory

Specified by:

range in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

terms

public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

terms in interface SearchAggregationFactory

Specified by:

terms in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

sum

public SumAggregationFieldStep<SR,PDF> sum()

Description copied from interface: TypedSearchAggregationFactory

Perform the sum metric aggregation.

Sums up the field values.

Specified by:

sum in interface ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

sum in interface SearchAggregationFactory

Specified by:

sum in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

min

public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

min in interface SearchAggregationFactory

Specified by:

min in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

max

public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

max in interface SearchAggregationFactory

Specified by:

max in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

count

public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

count in interface SearchAggregationFactory

Specified by:

count in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

countDistinct

@Deprecated(since="8.1",
            forRemoval=true)
public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

countDistinct in interface SearchAggregationFactory

Specified by:

countDistinct in interface TypedSearchAggregationFactory<SR>

Returns:

The next step.

avg

public 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 ExtendedSearchAggregationFactory<SR,S extends ExtendedSearchAggregationFactory<SR,S,PDF>,SC extends SearchAggregationIndexScope<?>>

Specified by:

avg in interface SearchAggregationFactory

Specified by:

avg in interface TypedSearchAggregationFactory<SR>

Returns:

the next step.

composite

public CompositeAggregationInnerStep composite()

Description copied from interface: SearchAggregationFactory

Starts the definition of a composite aggregation, which will combine multiple given aggregations.

Specified by:

composite in interface SearchAggregationFactory

Returns:

A DSL step where the "composite" aggregation can be defined in more details.

composite

public AggregationFinalStep<List<?>> composite(SearchAggregation<?>... aggregations)

Description copied from interface: SearchAggregationFactory

Create an aggregation that will compose a List based on the given aggregations.

Specified by:

composite in interface SearchAggregationFactory

Parameters:

aggregations - The aggregations used to populate the list, in order.

Returns:

The "composite" aggregation.

withParameters

public <T> AggregationFinalStep<T> withParameters(Function<? super NamedValues,? extends AggregationFinalStep<T>> aggregationCreator)

Description copied from interface: SearchAggregationFactory

Delegating aggregation that creates the actual aggregation at query create time and provides access to query parameters.

Which aggregation exactly to create is defined by a function passed to the arguments of this aggregation.

Specified by:

withParameters in interface SearchAggregationFactory

Parameters:

aggregationCreator - The function creating an actual aggregation.

Returns:

A final DSL step in a parameterized aggregation definition.

extension

public <T> T extension(SearchAggregationFactoryExtension<T> extension)

Description copied from interface: SearchAggregationFactory

Extend the current factory with the given extension, resulting in an extended factory offering different types of aggregations.

Specified by:

extension in interface SearchAggregationFactory

Type Parameters:

T - The type of factory provided by the extension.

Parameters:

extension - The extension to the aggregation DSL.

Returns:

The extended factory.

toAbsolutePath

public final String toAbsolutePath(String relativeFieldPath)

Specified by:

toAbsolutePath in interface SearchAggregationFactory

Parameters:

relativeFieldPath - The path to a field, relative to the root of this factory.

Returns:

The absolute path of the field, for use in native aggregations for example. Note the path is returned even if the field doesn't exist.