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

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

java.lang.Object

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

All Implemented Interfaces:

ExtendedSearchAggregationFactory<S,PDF>, SearchAggregationFactory

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Field Details

dslContext

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

Constructor Details

AbstractSearchAggregationFactory

public AbstractSearchAggregationFactory(SearchAggregationDslContext<SC,PDF> dslContext)

Method Details

range

public RangeAggregationFieldStep<PDF> range()

Description copied from interface: SearchAggregationFactory

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

Specified by:

range in interface SearchAggregationFactory

Returns:

The next step.

terms

public TermsAggregationFieldStep<PDF> terms()

Description copied from interface: SearchAggregationFactory

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

Specified by:

terms in interface SearchAggregationFactory

Returns:

The next step.

sum

public SumAggregationFieldStep<PDF> sum()

Description copied from interface: SearchAggregationFactory

Perform the sum metric aggregation.

Specified by:

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

Specified by:

sum in interface SearchAggregationFactory

Returns:

The next step.

min

public MinAggregationFieldStep<PDF> min()

Description copied from interface: SearchAggregationFactory

Perform the min metric aggregation.

Specified by:

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

Specified by:

min in interface SearchAggregationFactory

Returns:

The next step.

max

public MaxAggregationFieldStep<PDF> max()

Description copied from interface: SearchAggregationFactory

Perform the max metric aggregation.

Specified by:

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

Specified by:

max in interface SearchAggregationFactory

Returns:

The next step.

count

public CountAggregationFieldStep<PDF> count()

Description copied from interface: SearchAggregationFactory

Perform the count metric aggregation.

Specified by:

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

Specified by:

count in interface SearchAggregationFactory

Returns:

The next step.

countDistinct

public CountDistinctAggregationFieldStep<PDF> countDistinct()

Description copied from interface: SearchAggregationFactory

Perform the count distinct metric aggregation.

Specified by:

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

Specified by:

countDistinct in interface SearchAggregationFactory

Returns:

The next step.

avg

public AvgAggregationFieldStep<PDF> avg()

Description copied from interface: SearchAggregationFactory

Perform the avg metric aggregation.

Specified by:

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

Specified by:

avg in interface SearchAggregationFactory

Returns:

the next step.

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.