AggregationPipeline (morphia 1.0.1 API)

All Known Implementing Classes:

AggregationPipelineImpl
```
public interface AggregationPipeline
```
This defines the pipeline used in aggregation operations

See Also:
Aggregation Pipeline

Method Summary

Methods
Modifier and Type	Method and Description
`<U> Iterator<U>`	`aggregate(Class<U> target)` Executes the pipeline and aggregates the output in to the type mapped by the target type using the default options as defined in `AggregationOptions`.
`<U> Iterator<U>`	`aggregate(Class<U> target, AggregationOptions options)` Executes the pipeline and aggregates the output in to the type mapped by the target type.
`<U> Iterator<U>`	`aggregate(Class<U> target, AggregationOptions options, ReadPreference readPreference)` Executes the pipeline and aggregates the output in to the type mapped by the target type.
`<U> Iterator<U>`	`aggregate(String collectionName, Class<U> target, AggregationOptions options, ReadPreference readPreference)` Executes the pipeline and aggregates the output in to the type mapped by the target type.
`AggregationPipeline`	`geoNear(GeoNear geoNear)` Returns an ordered stream of documents based on the proximity to a geospatial point.
`AggregationPipeline`	`group(List<Group> id, Group... groupings)`
`AggregationPipeline`	`group(String id, Group... groupings)` Groups input documents by a specified identifier expression and applies the accumulator expression(s), if specified, to each group .
`AggregationPipeline`	`limit(int count)` Passes the first n documents unmodified to the pipeline where n is the specified limit.
`AggregationPipeline`	`match(Query query)` Filters the document stream to allow only matching documents to pass unmodified into the next pipeline stage.
`<U> Iterator<U>`	`out(Class<U> target)` Places the output of the aggregation in the collection mapped by the target type using the default options as defined in `AggregationOptions`.
`<U> Iterator<U>`	`out(Class<U> target, AggregationOptions options)` Places the output of the aggregation in the collection mapped by the target type.
`<U> Iterator<U>`	`out(String collectionName, Class<U> target)` Places the output of the aggregation in the collection mapped by the target type using the default options as defined in `AggregationOptions`.
`<U> Iterator<U>`	`out(String collectionName, Class<U> target, AggregationOptions options)` Places the output of the aggregation in the collection mapped by the target type.
`AggregationPipeline`	`project(Projection... projections)` Reshapes each document in the stream, such as by adding new fields or removing existing fields.
`AggregationPipeline`	`skip(int count)` Skips the first n documents where n is the specified skip number and passes the remaining documents unmodified to the pipeline.
`AggregationPipeline`	`sort(Sort... sorts)` Reorders the document stream by a specified sort key.
`AggregationPipeline`	`unwind(String field)` Deconstructs an array field from the input documents to output a document for each element.

- Method Detail
 - project
```
AggregationPipeline project(Projection... projections)
```
 Reshapes each document in the stream, such as by adding new fields or removing existing fields. For each input document, outputs one document.
 
 See Also:
 $project
 - group
```
AggregationPipeline group(String id,
 Group... groupings)
```
 Groups input documents by a specified identifier expression and applies the accumulator expression(s), if specified, to each group . Consumes all input documents and outputs one document per each distinct group. The output documents only contain the identifier field and, if specified, accumulated fields.
 
 See Also:
 $group
 - group
```
AggregationPipeline group(List<Group> id,
 Group... groupings)
```
 See Also:
 group(String, Group...)
 - match
```
AggregationPipeline match(Query query)
```
 Filters the document stream to allow only matching documents to pass unmodified into the next pipeline stage. $match uses standard MongoDB queries. For each input document, outputs either one document (a match) or zero documents (no match).
 
 See Also:
 $match
 - sort
```
AggregationPipeline sort(Sort... sorts)
```
 Reorders the document stream by a specified sort key. Only the order changes; the documents remain unmodified. For each input document, outputs one document.
 
 See Also:
 $sort
 - limit
```
AggregationPipeline limit(int count)
```
 Passes the first n documents unmodified to the pipeline where n is the specified limit. For each input document, outputs either one document (for the first n documents) or zero documents (after the first n documents).
 
 See Also:
 $limit
 - skip
```
AggregationPipeline skip(int count)
```
 Skips the first n documents where n is the specified skip number and passes the remaining documents unmodified to the pipeline. For each input document, outputs either zero documents (for the first n documents) or one document (if after the first n documents).
 
 See Also:
 $skip
 - unwind
```
AggregationPipeline unwind(String field)
```
 Deconstructs an array field from the input documents to output a document for each element. Each output document replaces the array with an element value. For each input document, outputs n documents where n is the number of array elements and can be zero for an empty array.
 
 See Also:
 $unwind
 - geoNear
```
AggregationPipeline geoNear(GeoNear geoNear)
```
 Returns an ordered stream of documents based on the proximity to a geospatial point. Incorporates the functionality of $match, $sort, and $limit for geospatial data. The output documents include an additional distance field and can include a location identifier field.
 
 See Also:
 $geoNear
 - out
```
 Iterator out(Class target)
```
 Places the output of the aggregation in the collection mapped by the target type using the default options as defined in AggregationOptions.
 
 Parameters:
 target - The class to use when iterating over the results
 
 Returns:
 an iterator of the computed results
 - out
```
 Iterator out(Class target,
 AggregationOptions options)
```
 Places the output of the aggregation in the collection mapped by the target type.
 
 Parameters:
 target - The class to use when iterating over the results
 options - The options to apply to this aggregation
 
 Returns:
 an iterator of the computed results
 - out
```
 Iterator out(String collectionName,
 Class target)
```
 Places the output of the aggregation in the collection mapped by the target type using the default options as defined in AggregationOptions.
 
 Parameters:
 collectionName - The collection in which to store the results of the aggregation overriding the mapped value in target
 target - The class to use when iterating over the results
 
 Returns:
 an iterator of the computed results
 - out
```
 Iterator out(String collectionName,
 Class target,
 AggregationOptions options)
```
 Places the output of the aggregation in the collection mapped by the target type.
 
 Parameters:
 collectionName - The collection in which to store the results of the aggregation overriding the mapped value in target
 target - The class to use when iterating over the results
 options - The options to apply to this aggregation
 
 Returns:
 an iterator of the computed results
 - aggregate
```
 Iterator aggregate(Class target)
```
 Executes the pipeline and aggregates the output in to the type mapped by the target type using the default options as defined in AggregationOptions.
 
 Parameters:
 target - The class to use when iterating over the results
 
 Returns:
 an iterator of the computed results
 - aggregate
```
 Iterator aggregate(Class target,
 AggregationOptions options)
```
 Executes the pipeline and aggregates the output in to the type mapped by the target type.
 
 Parameters:
 target - The class to use when iterating over the results
 options - The options to apply to this aggregation
 
 Returns:
 an iterator of the computed results
 - aggregate
```
 Iterator aggregate(Class target,
 AggregationOptions options,
 ReadPreference readPreference)
```
 Executes the pipeline and aggregates the output in to the type mapped by the target type.
 
 Parameters:
 target - The class to use when iterating over the results
 options - The options to apply to this aggregation
 readPreference - The read preference to apply to this pipeline
 
 Returns:
 an iterator of the computed results
 - aggregate
```
 Iterator aggregate(String collectionName,
 Class target,
 AggregationOptions options,
 ReadPreference readPreference)
```
 Executes the pipeline and aggregates the output in to the type mapped by the target type.
 
 Parameters:
 collectionName - The collection in which to store the results of the aggregation overriding the mapped value in target
 target - The class to use when iterating over the results
 options - The options to apply to this aggregation
 readPreference - The read preference to apply to this pipeline
 
 Returns:
 an iterator of the computed results

Interface AggregationPipeline

Method Summary

Method Detail

project

group

group

match

sort

limit

skip

unwind

geoNear

out

out

out

out

aggregate

aggregate

aggregate

aggregate