Package org.hibernate.search.backend.lucene.types.aggregation.impl

Class AbstractLuceneFacetsBasedTermsAggregation<F,T,K,V>

java.lang.Object

org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneNestableAggregation<Map<K,V>>

org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneBucketAggregation<K,Long>

org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneFacetsBasedTermsAggregation<F,T,K,V>

Type Parameters:

F - The type of field values exposed to the mapper.

T - The type of terms returned by the Lucene Facets.

K - The type of keys in the returned map. It can be F or a different type if value converters are used.

All Implemented Interfaces:

LuceneSearchAggregation<Map<K,Long>>, SearchAggregation<Map<K,Long>>

Direct Known Subclasses:

LuceneNumericTermsAggregation, LuceneTextTermsAggregation

public abstract class AbstractLuceneFacetsBasedTermsAggregation<F,T,K,V>
extends AbstractLuceneBucketAggregation<K,Long>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractLuceneFacetsBasedTermsAggregation.AbstractExtractor

Nested classes/interfaces inherited from interface org.hibernate.search.backend.lucene.search.aggregation.impl.LuceneSearchAggregation

LuceneSearchAggregation.Extractor<T>

Field Summary

Fields inherited from class org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneBucketAggregation

absoluteFieldPath

Fields inherited from interface org.hibernate.search.backend.lucene.search.aggregation.impl.LuceneSearchAggregation

log

Method Summary

Modifier and Type	Method	Description
protected abstract LuceneSearchAggregation.Extractor<Map<K,Long>>	extractor(AggregationRequestContext context)
LuceneSearchAggregation.Extractor<Map<K,Long>>	request(AggregationRequestContext context)	Request the collection of per-document data that will be used in LuceneSearchAggregation.Extractor.extract(AggregationExtractContext), making sure that the requirements for this projection are met.

Methods inherited from class org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneBucketAggregation

indexNames

Methods inherited from class org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneNestableAggregation

createNestedDocsProvider

Methods inherited from class java.lang.Object

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

Method Details

request

public LuceneSearchAggregation.Extractor<Map<K,Long>> request(AggregationRequestContext context)

Description copied from interface: LuceneSearchAggregation

Request the collection of per-document data that will be used in LuceneSearchAggregation.Extractor.extract(AggregationExtractContext), making sure that the requirements for this projection are met.

Parameters:

context - A context that will share its state with the context passed to LuceneSearchAggregation.Extractor.extract(AggregationExtractContext).

extractor

protected abstract LuceneSearchAggregation.Extractor<Map<K,Long>> extractor(AggregationRequestContext context)