All Known Implementing Classes:

AggregateBase, AggregateEsBase, DateHistogramAggregate, DateRangeAggregate, HistogramAggregate, MissingAggregate, MultiBucketAggregate, NativeEsAggregate, RangeAggregate, SignificantTermAggregate, SingleBucketAggregate, SingleValueMetricAggregate, TermAggregate
```
public interface Aggregate<B extends Bucket>
```
Since:

6.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Bucket`	`getBucket(String key)`
`List<B>`	`getBuckets()`	The aggregate results.
`List<AggregateRangeDateDefinition>`	`getDateRanges()`	Date Range definition for aggregate of type date range.
`List<Bucket>`	`getExtendedBuckets()`	The regular list of buckets plus buckets with doc count at 0 for selected buckets which are not returned from es post filtering.
`String`	`getField()`	Nuxeo field to aggregate.
`String`	`getId()`	The aggregate identifier.
`Map<String,String>`	`getProperties()`	Properties of the aggregate.
`List<AggregateRangeDefinition>`	`getRanges()`	Range definition for aggregate of type range.
`List<String>`	`getSelection()`	The selection filter that is going to be applied to the main query as a post filter.
`String`	`getType()`	Type of aggregation.
`String`	`getXPathField()`	Gets the field name as defined in Nuxeo.
`boolean`	`hasBucket(String key)`
`void`	`resetSelection()`
`void`	`setBuckets(List<B> buckets)`
`void`	`setSelection(List<String> selection)`

- Method Detail
  - getId
```
String getId()
```
    The aggregate identifier.
  - getType
```
String getType()
```
    Type of aggregation.
  - getField
```
String getField()
```
    Nuxeo field to aggregate.
  - getProperties
```
Map<String,String> getProperties()
```
    Properties of the aggregate.
  - getRanges
```
List<AggregateRangeDefinition> getRanges()
```
    Range definition for aggregate of type range.
  - getDateRanges
```
List<AggregateRangeDateDefinition> getDateRanges()
```
    Date Range definition for aggregate of type date range.
  - getSelection
```
List<String> getSelection()
```
    The selection filter that is going to be applied to the main query as a post filter.
  - setSelection
```
void setSelection(List<String> selection)
```
  - getBuckets
```
List<B> getBuckets()
```
    The aggregate results.
  - setBuckets
```
void setBuckets(List<B> buckets)
```
  - getBucket
```
Bucket getBucket(String key)
```
  - hasBucket
```
boolean hasBucket(String key)
```
  - resetSelection
```
void resetSelection()
```
  - getExtendedBuckets
```
List<Bucket> getExtendedBuckets()
```
    The regular list of buckets plus buckets with doc count at 0 for selected buckets which are not returned from es post filtering.
  - getXPathField
```
String getXPathField()
```
    Gets the field name as defined in Nuxeo.
    In Nuxeo the separator for a complex type is the `/` character, in a case where our Aggregate implementation defines a field as `file:content.mime-type`, this method should return `file:content/mime-type`.
    
    Since:
    
    11.1

Interface Aggregate<B extends Bucket>

Method Summary

Method Detail

getId

getType

getField

getProperties

getRanges

getDateRanges

getSelection

setSelection

getBuckets

setBuckets

getBucket

hasBucket

resetSelection

getExtendedBuckets

getXPathField