AbstractLuceneFacetsBasedTermsAggregation (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

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>

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>
extends AbstractLuceneBucketAggregation<K,Long>
```

Field Summary
- Fields inherited from class org.hibernate.search.backend.lucene.types.aggregation.impl.AbstractLuceneBucketAggregation
  absoluteFieldPath

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<K,Long>`	`extract(AggregationExtractContext context)`	Extract the result of the aggregation from the response.
`void`	`request(AggregationRequestContext context)`	Request the collection of per-document data that will be used in `LuceneSearchAggregation.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
getIndexNames

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 Detail
  - request
```
public void request(AggregationRequestContext context)
```
    Description copied from interface: LuceneSearchAggregation
    
    Request the collection of per-document data that will be used in LuceneSearchAggregation.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.extract(AggregationExtractContext).
  - extract
```
public final Map<K,Long> extract(AggregationExtractContext context)
                                throws IOException
```
    Description copied from interface: LuceneSearchAggregation
    
    Extract the result of the aggregation from the response.
    
    Parameters:
    
    context - The extract context, to extract information from the response's JSON body or retrieve information that was stored earlier in LuceneSearchAggregation.request(AggregationRequestContext).
    
    Returns:
    
    The aggregation result extracted from the response.
    
    Throws:
    
    IOException