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

Class TermsAggregationFieldStepImpl<PDF extends SearchPredicateFactory>

java.lang.Object

org.hibernate.search.engine.search.aggregation.dsl.impl.TermsAggregationFieldStepImpl<PDF>

All Implemented Interfaces:

TermsAggregationFieldStep<PDF>

public class TermsAggregationFieldStepImpl<PDF extends SearchPredicateFactory>
extends Object
implements TermsAggregationFieldStep<PDF>

Constructor Summary

Constructors

Constructor	Description
TermsAggregationFieldStepImpl(SearchAggregationDslContext<?,? extends PDF> dslContext)

Method Summary

Modifier and Type	Method	Description
<F> TermsAggregationOptionsStep<?,PDF,F,Map<F,Long>>	field(String fieldPath, Class<F> type, ValueConvert convert)	Target the given field in the terms aggregation.

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.TermsAggregationFieldStep

field

Constructor Detail

TermsAggregationFieldStepImpl

public TermsAggregationFieldStepImpl(SearchAggregationDslContext<?,? extends PDF> dslContext)

Method Detail

field

public <F> TermsAggregationOptionsStep<?,PDF,F,Map<F,Long>> field(String fieldPath,
                                                                                          Class<F> type,
                                                                                          ValueConvert convert)

Description copied from interface: TermsAggregationFieldStep

Target the given field in the terms aggregation.

Specified by:

field in interface TermsAggregationFieldStep<PDF extends SearchPredicateFactory>

Type Parameters:

F - The type of field values.

Parameters:

fieldPath - The path to the index field to aggregate.

type - The type of field values.

convert - Controls how the ranges passed to the next steps and fetched from the backend should be converted. See ValueConvert.

Returns:

The next step.