FilterAggregation

java.lang.Object
- lumis.portal.bigdata.query.AbstractSubAggregationAwareAggregation
- - lumis.portal.bigdata.query.FilterAggregation

All Implemented Interfaces:

IAggregation, ISubAggregationAwareAggregation
```
@StableMinor(version="14.0",
             sinceVersion="11.0")
public class FilterAggregation
extends AbstractSubAggregationAwareAggregation
```
Aggregation used to narrow down the current query document space. Typically, this aggregation is used with sub aggregations. Produces a sub aggregation aware result.

Since:

11.0.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  protected String id
- Constructor Summary
  
  Constructors
  Constructor Description
  
  FilterAggregation(String id, ISearchQueryFilter filter)
  Creates a new filter aggregation.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  ISearchQueryFilter getFilter()
  Returns the filter.
  
  String getId()
  Returns the aggregation identifier.
  - Methods inherited from class lumis.portal.bigdata.query.AbstractSubAggregationAwareAggregation
    addSubAggregation, addSubAggregations, addSubAggregations, getSubAggregations
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface lumis.portal.bigdata.query.IAggregation
    getId

- Field Detail
  - id
```
protected final String id
```
- Constructor Detail
  - FilterAggregation
```
public FilterAggregation(String id,
                         ISearchQueryFilter filter)
```
    Creates a new filter aggregation.
    
    Parameters:
    
    id - the aggregation identifier.
    
    filter - the filter used to narrow down the documents.
    
    Since:
    
    11.0.0
- Method Detail
  - getFilter
```
public ISearchQueryFilter getFilter()
```
    Returns the filter.
    
    Returns:
    
    the filter.
    
    Since:
    
    11.0.0
  - getId
```
public String getId()
```
    Description copied from interface: IAggregation
    
    Returns the aggregation identifier.
    
    Specified by:
    
    getId in interface IAggregation
    
    Returns:
    
    the aggregation identifier.