com.allanbank.mongodb.builder

Class AggregationGroupField

java.lang.Object

com.allanbank.mongodb.builder.AggregationGroupField

public class AggregationGroupField
extends Object

AggregationGroupField holds the information for an aggregation field in an aggregate command's $group pipeline operator.

See Also:

MongoDB Aggregate Command $group Operator

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationGroupField.Builder Builder provides the ability to construct a AggregationGroupField .

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregationGroupField(String name, String operator, int value) Creates a new AggregationGroupField.
protected	AggregationGroupField(String name, String operator, String fieldRef) Creates a new AggregationGroupField.

Method Summary

Methods

Modifier and Type	Method and Description
static AggregationGroupField.Builder	set(String fieldName) Helper method for creating AggregationGroupField.Builders using with a specific fieldName.
Element	toElement() Returns the element for the group operator's field.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationGroupField

protected AggregationGroupField(String name,
                     String operator,
                     int value)

Creates a new AggregationGroupField.

Parameters:

name - The name of the output document field to be set.

operator - The operator to use to perform the aggregation.

value - The value to supply the operator.

AggregationGroupField

protected AggregationGroupField(String name,
                     String operator,
                     String fieldRef)

Creates a new AggregationGroupField.

Parameters:

name - The name of the output document field to be set.

operator - The operator to use to perform the aggregation.

fieldRef - The field reference to use. If the fieldRef does not start with a '$' then one will be added.

Method Detail

set

public static AggregationGroupField.Builder set(String fieldName)

Helper method for creating AggregationGroupField.Builders using with a specific fieldName.

Parameters:

fieldName - The name of the output document field to be set.

Returns:

The builder for constructing the AggregationGroupField.

See Also:

MongoDB Aggregate Command $group Operator

toElement

public Element toElement()

Returns the element for the group operator's field.

Returns:

The element for the group operator's field.