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

Interface SearchAggregationFactoryExtension<T>

Type Parameters:

T - The type of extended aggregation factories. Should generally extend SearchAggregationFactory.

All Known Implementing Classes:

ElasticsearchExtension, LuceneExtension

public interface SearchAggregationFactoryExtension<T>

An extension to the search aggregation DSL, allowing the use of non-standard aggregations in a query.

WARNING: while this type is API, because instances should be manipulated by users, all of its methods are considered SPIs and therefore should never be called or implemented directly by users. In short, users are only expected to get instances of this type from an API (SomeExtension.get()) and pass it to another API.

See Also:

• SearchAggregationFactory.extension(SearchAggregationFactoryExtension)
• ExtendedSearchAggregationFactory

Method Summary

Modifier and Type	Method	Description
Optional<T>	extendOptional(SearchAggregationFactory original)	Attempt to extend a given factory, returning an empty Optional in case of failure.

Method Details

extendOptional

Optional<T> extendOptional(SearchAggregationFactory original)

Attempt to extend a given factory, returning an empty Optional in case of failure.

WARNING: this method is not API, see comments at the type level.

Parameters:

original - The original, non-extended SearchAggregationFactory.

Returns:

An optional containing the extended aggregation factory (SearchAggregationFactoryExtension) in case of success, or an empty optional otherwise.