com.allanbank.mongodb.builder

Class AggregationProjectFields

java.lang.Object

com.allanbank.mongodb.builder.AggregationProjectFields

public class AggregationProjectFields
extends Object

AggregationProjectFields holds the information for the fields to copy from the input documents when using the aggregate command's $project pipeline operator.

See Also:

MongoDB Aggregate Command $project 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

Constructor Summary

Constructors

Constructor and Description
AggregationProjectFields(boolean includeId, String... fields) Creates a new AggregationProjectFields.
AggregationProjectFields(String... fields) Creates a new AggregationProjectFields.

Method Summary

Methods

Modifier and Type	Method and Description
static AggregationProjectFields	include(String... fields) Helper method to create a AggregationProjectFields that implicitly includes the _id field.
static AggregationProjectFields	includeWithoutId(String... fields) Helper method to create a AggregationProjectFields that does not include the _id field.
List<IntegerElement>	toElements() Returns the elements describing the fields to be included (and if the _id should be excluded).

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationProjectFields

public AggregationProjectFields(boolean includeId,
                        String... fields)

Creates a new AggregationProjectFields.

Parameters:

includeId - If false then the _id field will be excluded from the fields in the results of the $project operation.

fields - The fields to include in the results of the $project operation.

AggregationProjectFields

public AggregationProjectFields(String... fields)

Creates a new AggregationProjectFields.

Parameters:

fields - The fields to include in the results of the $project operation.

Method Detail

include

public static AggregationProjectFields include(String... fields)

Helper method to create a AggregationProjectFields that implicitly includes the _id field.

Parameters:

fields - The fields to be included.

Returns:

The AggregationProjectFields.

includeWithoutId

public static AggregationProjectFields includeWithoutId(String... fields)

Helper method to create a AggregationProjectFields that does not include the _id field.

Parameters:

fields - The fields to be included.

Returns:

The AggregationProjectFields.

toElements

public List<IntegerElement> toElements()

Returns the elements describing the fields to be included (and if the _id should be excluded).

Returns:

The elements describing the fields to be included (and if the _id should be excluded).