AggregationGroupField.Builder (mongodb-async-driver 2.0.1 API)

java.lang.Object
- com.allanbank.mongodb.builder.AggregationGroupField.Builder

Enclosing class:

AggregationGroupField
```
public static class AggregationGroupField.Builder
extends Object
```
Builder provides the ability to construct a AggregationGroupField .
This AggregationGroupField.Builder does not support a build() method or support chaining of method calls. Instead each builder method returns a AggregationGroupField. This is to more closely match the semantics of the group operator which cannot build complex structures for each field.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors
Constructor and Description

AggregationGroupField.Builder(String fieldName)
Creates a new Builder.

Constructors
Constructor and Description
`AggregationGroupField.Builder(String fieldName)` Creates a new Builder.

Method Summary

Methods
Modifier and Type	Method and Description
`AggregationGroupField`	`addToSet(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$addToSet` operator to accumulate the unique values of the `fieldRef`.
`AggregationGroupField`	`all(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$push` operator to accumulate all of the values seen from the `fieldRef`.
`AggregationGroupField`	`as(String operator, int value)` Constructs a new `AggregationGroupField` object that uses the custom operator to aggregate all of the values seen from the `fieldRef`.
`AggregationGroupField`	`as(String operator, String fieldRef)` Constructs a new `AggregationGroupField` object that uses the custom operator to aggregate all of the values seen from the `fieldRef`.
`AggregationGroupField`	`average(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$avg` operator to compute the average value seen from the `fieldRef`.
`AggregationGroupField`	`count()` Constructs a new `AggregationGroupField` object that uses the `$sum` operator to count all of the input documents.
`AggregationGroupField`	`first(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$first` operator to use the first value seen from the `fieldRef`.
`AggregationGroupField`	`last(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$last` operator to use the last value seen from the `fieldRef`.
`AggregationGroupField`	`maximum(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$max` operator to use the maximum value seen from the `fieldRef`.
`AggregationGroupField`	`minimum(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$min` operator to use the minimum value seen from the `fieldRef`.
`AggregationGroupField`	`push(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$push` operator to accumulate all of the values seen from the `fieldRef`.
`AggregationGroupField`	`sum(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$sum` operator to sum all of the values seen from the `fieldRef`.
`AggregationGroupField`	`uniqueValuesOf(String fieldRef)` Constructs a new `AggregationGroupField` object that uses the `$addToSet` operator to accumulate the unique values of the `fieldRef`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AggregationGroupField.Builder
```
public AggregationGroupField.Builder(String fieldName)
```
    Creates a new Builder.
    
    Parameters:
    fieldName - The name of the field to set with the result of the aggregation/group.
- Method Detail
  - addToSet
```
public AggregationGroupField addToSet(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $addToSet operator to accumulate the unique values of the fieldRef.
    This is an alias for uniqueValuesOf(String).
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $addToSet
  - all
```
public AggregationGroupField all(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $push operator to accumulate all of the values seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $push
  - as
```
public AggregationGroupField as(String operator,
                       int value)
```
    Constructs a new AggregationGroupField object that uses the custom operator to aggregate all of the values seen from the fieldRef.
    
    Parameters:
    operator - The operator to use.
    value - The value to use in the aggregation.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator
  - as
```
public AggregationGroupField as(String operator,
                       String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the custom operator to aggregate all of the values seen from the fieldRef.
    
    Parameters:
    operator - The operator to use.
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator
  - average
```
public AggregationGroupField average(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $avg operator to compute the average value seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $avg
  - count
```
public AggregationGroupField count()
```
    Constructs a new AggregationGroupField object that uses the $sum operator to count all of the input documents.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $sum
  - first
```
public AggregationGroupField first(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $first operator to use the first value seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $first
  - last
```
public AggregationGroupField last(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $last operator to use the last value seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $last
  - maximum
```
public AggregationGroupField maximum(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $max operator to use the maximum value seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $max
  - minimum
```
public AggregationGroupField minimum(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $min operator to use the minimum value seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $min
  - push
```
public AggregationGroupField push(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $push operator to accumulate all of the values seen from the fieldRef.
    This is an alias for all(String).
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $push
  - sum
```
public AggregationGroupField sum(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $sum operator to sum all of the values seen from the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $sum
  - uniqueValuesOf
```
public AggregationGroupField uniqueValuesOf(String fieldRef)
```
    Constructs a new AggregationGroupField object that uses the $addToSet operator to accumulate the unique values of the fieldRef.
    
    Parameters:
    fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.
    
    Returns:
    The new AggregationGroupField object.
    See Also:
    MongoDB Aggregate Command $group Operator - $addToSet

Class AggregationGroupField.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AggregationGroupField.Builder

Method Detail

addToSet

all

as

as

average

count

first

last

maximum

minimum

push

sum

uniqueValuesOf