Uses of Interface
org.hibernate.search.engine.search.aggregation.dsl.AggregationFinalStep

Packages that use AggregationFinalStep

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

Uses of AggregationFinalStep in org.hibernate.search.engine.search.aggregation.dsl

Subinterfaces of AggregationFinalStep in org.hibernate.search.engine.search.aggregation.dsl

Modifier and Type	Interface	Description
interface	AvgAggregationOptionsStep<SR,S extends AvgAggregationOptionsStep<SR,?,PDF,F>,PDF extends TypedSearchPredicateFactory<SR>,F>	The final step in a "avg" aggregation definition, where optional parameters can be set.
interface	CountDistinctValuesAggregationOptionsStep<SR,S extends CountDistinctValuesAggregationOptionsStep<SR,?,PDF>,PDF extends TypedSearchPredicateFactory<SR>>	The final step in a "count distinct" aggregation definition, where optional parameters can be set.
interface	CountDocumentsAggregationFinalStep	The initial and final step in a "count documents" aggregation definition.
interface	CountValuesAggregationOptionsStep<SR,S extends CountValuesAggregationOptionsStep<SR,?,PDF>,PDF extends TypedSearchPredicateFactory<SR>>	The final step in a "count" aggregation definition, where optional parameters can be set.
interface	MaxAggregationOptionsStep<SR,S extends MaxAggregationOptionsStep<SR,?,PDF,F>,PDF extends TypedSearchPredicateFactory<SR>,F>	The final step in a "max" aggregation definition, where optional parameters can be set.
interface	MinAggregationOptionsStep<SR,S extends MinAggregationOptionsStep<SR,?,PDF,F>,PDF extends TypedSearchPredicateFactory<SR>,F>	The final step in a "min" aggregation definition, where optional parameters can be set.
interface	RangeAggregationOptionsStep<SR,S extends RangeAggregationOptionsStep<SR,?,PDF,F,A>,PDF extends TypedSearchPredicateFactory<SR>,F,A>	The final step in a "range" aggregation definition, where optional parameters can be set.
interface	RangeAggregationRangeMoreStep<SR,S extends RangeAggregationRangeMoreStep<SR,?,?,PDF,F,A>,N extends RangeAggregationOptionsStep<SR,?,PDF,F,Map<org.hibernate.search.util.common.data.Range<F>,A>>,PDF extends TypedSearchPredicateFactory<SR>,F,A>	The step in a "range" aggregation definition where optional parameters can be set, (see the superinterface RangeAggregationOptionsStep), or more ranges can be added.
interface	SumAggregationOptionsStep<SR,S extends SumAggregationOptionsStep<SR,?,PDF,F>,PDF extends TypedSearchPredicateFactory<SR>,F>	The final step in a "sum" aggregation definition, where optional parameters can be set.
interface	TermsAggregationOptionsStep<SR,S extends TermsAggregationOptionsStep<SR,?,PDF,F,A>,PDF extends TypedSearchPredicateFactory<SR>,F,A>	The final step in a "terms" aggregation definition, where optional parameters can be set.
interface	TermsAggregationValueStep<SR,S extends TermsAggregationOptionsStep<SR,?,PDF,F,A>,PDF extends TypedSearchPredicateFactory<SR>,F,A>	The step in a "terms" aggregation definition where the aggregation value for the term can be set.

Methods in org.hibernate.search.engine.search.aggregation.dsl that return AggregationFinalStep

Modifier and Type	Method	Description
<V> AggregationFinalStep<V>	CompositeAggregationFrom1AsStep.as(Function<V1,V> transformer)	Defines the result of the composite aggregation as the result of applying the given function to the single inner aggregation defined so far.
<V> AggregationFinalStep<V>	CompositeAggregationFrom2AsStep.as(BiFunction<V1,V2,V> transformer)	Defines the result of the composite aggregation as the result of applying the given function to the two inner aggregations defined so far.
<V> AggregationFinalStep<V>	CompositeAggregationFrom3AsStep.as(org.hibernate.search.util.common.function.TriFunction<V1,V2,V3,V> transformer)	Defines the result of the composite aggregation as the result of applying the given function to the three inner aggregations defined so far.
AggregationFinalStep<Object[]>	CompositeAggregationFromAsStep.asArray()	Defines the result of the composite aggregation as an object array that will contain the results of inner aggregations defined so far, in order.
<V> AggregationFinalStep<V>	CompositeAggregationFromAsStep.asArray(Function<? super Object[],? extends V> transformer)	Defines the result of the composite aggregation as the result of applying the given function to an object array containing the results of inner aggregations defined so far, in order.
AggregationFinalStep<List<?>>	CompositeAggregationFromAsStep.asList()	Defines the result of the composite aggregation as a List that will contain the results of inner aggregations defined so far, in order.
<V> AggregationFinalStep<V>	CompositeAggregationFromAsStep.asList(Function<? super List<?>,? extends V> transformer)	Defines the result of the composite aggregation as the result of applying the given function to a List containing the results of inner aggregations defined so far, in order.
default AggregationFinalStep<List<?>>	SearchAggregationFactory.composite(AggregationFinalStep<?>... dslFinalSteps)	Create an aggregation that will compose a List based on the given almost-built aggregations.
AggregationFinalStep<List<?>>	SearchAggregationFactory.composite(SearchAggregation<?>... aggregations)	Create an aggregation that will compose a List based on the given aggregations.
<T> AggregationFinalStep<T>	SearchAggregationFactory.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 in org.hibernate.search.engine.search.aggregation.dsl with parameters of type AggregationFinalStep

Modifier and Type	Method	Description
default AggregationFinalStep<List<?>>	SearchAggregationFactory.composite(AggregationFinalStep<?>... dslFinalSteps)	Create an aggregation that will compose a List based on the given almost-built aggregations.
CompositeAggregationFromAsStep	CompositeAggregationInnerStep.from(AggregationFinalStep<?>... dslFinalSteps)	Defines multiple inner aggregations to get values from, based on almost-built SearchAggregations.
default <V1> CompositeAggregationFrom1AsStep<V1>	CompositeAggregationInnerStep.from(AggregationFinalStep<V1> dslFinalStep)	Defines one inner aggregation to get values from, based on an almost-built SearchAggregation.
default <V1, V2> CompositeAggregationFrom2AsStep<V1,V2>	CompositeAggregationInnerStep.from(AggregationFinalStep<V1> dslFinalStep1, AggregationFinalStep<V2> dslFinalStep2)	Defines two inner aggregations to get values from, based on almost-built SearchAggregations.
default <V1, V2, V3> CompositeAggregationFrom3AsStep<V1,V2,V3>	CompositeAggregationInnerStep.from(AggregationFinalStep<V1> dslFinalStep1, AggregationFinalStep<V2> dslFinalStep2, AggregationFinalStep<V3> dslFinalStep3)	Defines three inner aggregations to get values from, based on almost-built SearchAggregations.
default <T> RangeAggregationOptionsStep<SR,?,PDF,F,Map<org.hibernate.search.util.common.data.Range<F>,T>>	RangeAggregationValueStep.value(AggregationFinalStep<T> aggregation)	Specify which aggregation to apply to the documents within the range.
default <T> TermsAggregationOptionsStep<SR,?,PDF,F,Map<F,T>>	TermsAggregationValueStep.value(AggregationFinalStep<T> aggregation)	Specify which aggregation to apply to the documents with same terms.

Method parameters in org.hibernate.search.engine.search.aggregation.dsl with type arguments of type AggregationFinalStep

Modifier and Type	Method	Description
<T> AggregationFinalStep<T>	SearchAggregationFactory.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.

Uses of AggregationFinalStep in org.hibernate.search.engine.search.aggregation.dsl.spi

Methods in org.hibernate.search.engine.search.aggregation.dsl.spi that return AggregationFinalStep

Modifier and Type	Method	Description
AggregationFinalStep<List<?>>	AbstractSearchAggregationFactory.composite(SearchAggregation<?>... aggregations)
<T> AggregationFinalStep<T>	AbstractSearchAggregationFactory.withParameters(Function<? super NamedValues,? extends AggregationFinalStep<T>> aggregationCreator)

Method parameters in org.hibernate.search.engine.search.aggregation.dsl.spi with type arguments of type AggregationFinalStep

Modifier and Type	Method	Description
<T> AggregationFinalStep<T>	AbstractSearchAggregationFactory.withParameters(Function<? super NamedValues,? extends AggregationFinalStep<T>> aggregationCreator)

Uses of AggregationFinalStep in org.hibernate.search.engine.search.aggregation.spi

Method parameters in org.hibernate.search.engine.search.aggregation.spi with type arguments of type AggregationFinalStep

Modifier and Type	Method	Description
void	WithParametersAggregationBuilder.creator(Function<? super NamedValues,? extends AggregationFinalStep<T>> aggregationCreator)

Uses of AggregationFinalStep in org.hibernate.search.engine.search.query.dsl

Method parameters in org.hibernate.search.engine.search.query.dsl with type arguments of type AggregationFinalStep

Modifier and Type	Method	Description
<T> S	SearchQueryOptionsStep.aggregation(AggregationKey<T> key, Function<? super AF,? extends AggregationFinalStep<T>> aggregationContributor)	Add an aggregation to this query.

Uses of AggregationFinalStep in org.hibernate.search.engine.search.query.dsl.spi

Method parameters in org.hibernate.search.engine.search.query.dsl.spi with type arguments of type AggregationFinalStep

Modifier and Type	Method	Description
<A> S	AbstractSearchQueryOptionsStep.aggregation(AggregationKey<A> key, Function<? super AF,? extends AggregationFinalStep<A>> aggregationContributor)