com.allanbank.mongodb.builder

Class AggregationGroupId

java.lang.Object

com.allanbank.mongodb.builder.AggregationGroupId

public class AggregationGroupId
extends Object

AggregationGroupId holds the information for the _id 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	AggregationGroupId.Builder Builder provides the ability to construct a complex AggregationGroupId.

Constructor Summary

Constructors

Constructor and Description
AggregationGroupId(DocumentAssignable builder) Creates a new AggregationGroupId.
AggregationGroupId(String value) Creates a new AggregationGroupId.

Method Summary

Methods

Modifier and Type	Method and Description
static AggregationGroupId	constantId(String value) Constructs a AggregationGroupId with a constant value.
static AggregationGroupId.Builder	id() Creates a builder to construct a complex _id value for the group.
static AggregationGroupId	id(String fieldRef) Constructs a AggregationGroupId with a value from a single field in the source documents.
Element	toElement() Returns the element for the group operator's id.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationGroupId

public AggregationGroupId(DocumentAssignable builder)

Creates a new AggregationGroupId.

Parameters:

builder - The builder containing the details of the id.

AggregationGroupId

public AggregationGroupId(String value)

Creates a new AggregationGroupId.

Parameters:

value - The value for the simple group id.

Method Detail

constantId

public static AggregationGroupId constantId(String value)

Constructs a AggregationGroupId with a constant value.

Parameters:

value - The value of the _id.

Returns:

The AggregationGroupId with a constant value.

See Also:

MongoDB Aggregate Command $group Operator

id

public static AggregationGroupId.Builder id()

Creates a builder to construct a complex _id value for the group.

Returns:

The builder for the aggregation $group's id.

See Also:

MongoDB Aggregate Command $group Operator

id

public static AggregationGroupId id(String fieldRef)

Constructs a AggregationGroupId with a value from a single field in the source documents.

Parameters:

fieldRef - The field name in the source documents to use in constructing the _id of the group'd documents. If the fieldRef does not start with a '$' then one will be added.

Returns:

The AggregationGroupId with a single field value reference (which may resolve to a complex sub-document).

See Also:

MongoDB Aggregate Command $group Operator

toElement

public Element toElement()

Returns the element for the group operator's id.

Returns:

The element for the group operator's id.